翻訳、書籍、章
翻訳版を閲覧したり、書籍一覧を表示したり、章の内容を取得したりするためのエンドポイント。
章の内容、翻訳全文のダウンロード、単語レベルの注釈は、それぞれ2つの形式で利用可能です。
- 標準フォーマット― オリジナルの構造化されたフォーマット。詩の内容は、あなたが自分で組み立てる要素(プレーンテキスト、書式付きテキスト、脚注参照など)のリストです。
- 簡略化された形式- 各詩の内容が単一の文字列であり、脚注、詩、その他のマークアップはその文字列へのオフセットとして表現される、フラット化された形式。
テキストの表示方法や処理方法に最も適した形式を使用してください。
利用可能な翻訳
GET https://bible.helloao.org/api/available_translations.json
APIで利用可能な翻訳の一覧を取得します。
コード例
JavaScript
fetch(`https://bible.helloao.org/api/available_translations.json`)
.then(request => request.json())
.then(availableTranslations => {
console.log('The API has the following translations:', availableTranslations);
});cURL
curl https://bible.helloao.org/api/available_translations.json構造
export interface AvailableTranslations {
/**
* 翻訳一覧。
*/
translations: Translation[];
}
interface Translation {
/**
* 翻訳のID。
*/
id: string;
/**
* 翻訳の名前。
* これは通常、翻訳元の言語における翻訳名です。
*/
name: string;
/**
* 翻訳の英語名。
*/
englishName: string;
/**
* 翻訳サイト。
*/
website: string;
/**
* 翻訳ライセンスが掲載されているURL。
*/
licenseUrl: string;
/**
* API に追加されたライセンスに関する注記。
* メモがない場合は、nullまたはundefinedになります。
*/
licenseNotes?: string | null;
/**
* 翻訳コンテンツを表示する際に表示すべき通知。
* 翻訳に通知がない場合は、nullまたはundefinedになります。
*/
licenseNotice?: string | null;
/**
* 翻訳で検出された構造化ライセンス条項。
* 条件が特定できなかった場合は、nullまたは未定義となります。
* その場合は、licenseUrl のページで利用規約を確認してください。
*/
license?: License | null;
/**
* 翻訳の略称。
*/
shortName: string;
/**
* 翻訳が主に使用されているISO 639の3文字言語タグ。
*/
language: string;
/**
* 翻訳元の言語名を取得します。
* 言語名が不明な場合は、nullまたはundefinedになります。
*/
languageName?: string;
/**
* 言語名を英語で取得します。
* 言語に英語名がない場合は、nullまたはundefinedになります。
*/
languageEnglishName?: string;
/**
* 言語が書かれている方向。
* 「ltr」は、テキストがページの左側から右側に向かって書かれていることを示します。
* 「rtl」は、テキストがページの右側から左側に向かって書かれていることを示します。
*/
textDirection: 'ltr' | 'rtl';
/**
* 利用可能なフォーマットの一覧。
*/
availableFormats: ('json' | 'usfm')[];
/**
* この翻訳で利用可能な書籍の一覧へのAPIリンク。
*/
listOfBooksApiLink: string;
/**
* この翻訳に含まれる書籍の数。
*
* 完全な翻訳版は、聖書と同じ冊数(66冊)であるべきだ。
*/
numberOfBooks: number;
/**
* この翻訳版に含まれる章の総数。
*
* 完全な翻訳版は、聖書と同じ章数(1,189章)を持つべきである。
*/
totalNumberOfChapters: number;
/**
* この翻訳に含まれる節の総数。
*
* 完全な翻訳は聖書と同じ節数(約31,102節)を持つべきである(ただし、一部の翻訳では、原典に存在する可能性が高いと思われる節が除外されている)。
*/
totalNumberOfVerses: number;
/**
* この翻訳に含まれる外典の総数。
* 翻訳に外典が含まれていない場合は省略する。
*/
numberOfApocryphalBooks?: number;
/**
* この翻訳に含まれる外典の章の総数。
* 翻訳に外典が含まれていない場合は省略する。
*/
totalNumberOfApocryphalChapters?: number;
/**
* この翻訳に含まれる外典の節の総数。
* 翻訳に外典が含まれていない場合は省略する。
*/
totalNumberOfApocryphalVerses?: number;
}
/**
* 翻訳に対して検出された構造化ライセンス条項を定義します。
*/
interface License {
/**
* 翻訳を使用する際に、元の出典を明記する必要があるかどうか。
*/
attribution: 'required' | 'not-required';
/**
* 翻訳の商用利用が許可されているかどうか。
*/
commercialUse: 'allowed' | 'not-allowed';
/**
* 翻訳の派生作品の作成および配布が許可されているかどうか。
*/
derivatives: 'allowed' | 'not-allowed';
/**
* 派生作品は同一のライセンスの下で配布されなければならないか(つまり、「同一条件での共有」が求められるか)。
*/
copyleft: boolean;
/**
* その翻訳がパブリックドメインに提供されているかどうか。
*/
publicDomain: boolean;
}ライセンス
各翻訳はそれぞれ独自のライセンスに基づいて公開されているため、使用する前に翻訳の利用規約を確認してください。
licenseUrl常に完全なライセンス条項へのリンクです。licenseNoticeが存在する場合、それは翻訳コンテンツとともに表示される著作権または帰属表示です。licenseNotes、ソーステキストに加えられた変更など、APIによって追加されたメモが含まれています。license存在する場合、コードでチェックできる形式で用語を要約します。たとえば、商用利用が許可されている翻訳のみにリストを絞り込むことができます。
fetch(`https://bible.helloao.org/api/available_translations.json`)
.then(request => request.json())
.then(({ translations }) => {
const commercial = translations.filter(
t => t.license?.commercialUse === 'allowed'
);
console.log('Translations that allow commercial use:', commercial);
});licenseは、用語が自動的に検出された場合にのみ設定されます。0が設定されていない翻訳でも使用できる場合がありますので、 licenseUrlのページをご覧ください。
例
{
"translations": [
{
"id": "BSB",
"name": "Berean Standard Bible",
"website": "https://berean.bible/",
"licenseUrl": "https://berean.bible/",
"shortName": "BSB",
"englishName": "Berean Standard Bible",
"language": "eng",
"textDirection": "ltr",
"availableFormats": [
"json"
],
"listOfBooksApiLink": "/api/BSB/books.json",
"numberOfBooks": 66,
"totalNumberOfChapters": 1189,
"totalNumberOfVerses": 31086,
"languageName": "English",
"languageEnglishName": "English"
}
]
}翻訳された書籍一覧
GET https://bible.helloao.org/api/{translation}/books.json
指定された翻訳版で利用可能な書籍のリストを取得します。
translationは翻訳の ID です (例:BSB)。
コード例
JavaScript
const translation = 'BSB';
// BSB翻訳の書籍リストを入手する
fetch(`https://bible.helloao.org/api/${translation}/books.json`)
.then(request => request.json())
.then(books => {
console.log('The BSB has the following books:', books);
});cURL
curl https://bible.helloao.org/api/BSB/books.json構造
export interface TranslationBooks {
/**
* 書籍の翻訳情報。
*/
translation: Translation;
/**
* 翻訳可能な書籍の一覧。
*/
books: TranslationBook[];
}
interface TranslationBook {
/**
* 本のID。
*/
id: string;
/**
* 翻訳者がその本に付けた名前。
*/
name: string;
/**
* その本の通称。
*/
commonName: string;
/**
* 翻訳者がその書籍に付けた略称(短縮形)。
* 利用できない場合は、翻訳時に提供されなかったことを意味します。
*/
shortName?: string;
/**
* 本のタイトル。
* これは通常、本のタイトルをより詳しく説明したものです。
* 利用できない場合は、翻訳時に提供されなかったことを意味します。
*/
title: string | null;
/**
* 翻訳における書籍の番号順。
*/
order: number;
/**
* その本に含まれる章の数。
*/
numberOfChapters: number;
/**
* 本書における最初の章の番号。
*/
firstChapterNumber: number;
/**
* 本書の第1章へのリンク。
*/
firstChapterApiLink: string;
/**
* その本の最終章の番号。
*/
lastChapterNumber: number;
/**
* 本書の最終章へのリンク。
*/
lastChapterApiLink: string;
/**
* その書物に収録されている節の数。
*/
totalNumberOfVerses: number;
/**
* その本が偽書かどうか。
* 翻訳が正典である場合は省略されます。
*/
isApocryphal?: boolean;
}例
{
"translation": {
"id": "BSB",
"name": "Berean Standard Bible",
"website": "https://berean.bible/",
"licenseUrl": "https://berean.bible/",
"shortName": "BSB",
"englishName": "Berean Standard Bible",
"language": "eng",
"textDirection": "ltr",
"availableFormats": [
"json"
],
"listOfBooksApiLink": "/api/BSB/books.json",
"numberOfBooks": 66,
"totalNumberOfChapters": 1189,
"totalNumberOfVerses": 31086,
"languageName": "English",
"languageEnglishName": "English"
},
"books": [
{
"id": "GEN",
"translationId": "BSB",
"name": "Genesis",
"commonName": "Genesis",
"shortName": "Gen",
"title": "Genesis",
"order": 1,
"numberOfChapters": 50,
"firstChapterNumber": 1,
"firstChapterApiLink": "/api/BSB/GEN/1.json",
"lastChapterNumber": 50,
"lastChapterApiLink": "/api/BSB/GEN/50.json",
"totalNumberOfVerses": 1533
},
]
}