Free Use Bible API
指南
参考
SDK
GitHub
捐赠
  • English
  • Afrikaans
  • አማርኛ
  • العربية
  • বাংলা
  • Deutsch
  • Español
  • Français
  • Hausa
  • हिन्दी
  • Bahasa Indonesia
  • Italiano
  • 日本語
  • Português
  • Русский
  • Kiswahili
  • اردو
  • 简体中文
  • isiZulu
指南
参考
SDK
GitHub
捐赠
  • English
  • Afrikaans
  • አማርኛ
  • العربية
  • বাংলা
  • Deutsch
  • Español
  • Français
  • Hausa
  • हिन्दी
  • Bahasa Indonesia
  • Italiano
  • 日本語
  • Português
  • Русский
  • Kiswahili
  • اردو
  • 简体中文
  • isiZulu
  • 参考

    • API
    • 译本、书卷与章节

      • 译文、书籍和章节
      • 标准格式
      • 简化格式
    • 注释书

      • 评论
    • 数据集

      • 数据集
    • OpenAPI

译文、书籍和章节

用于浏览译文、列出书籍和获取章节内容的端点。

章节内容、完整翻译下载和词级注释均提供两种格式:

  • 标准格式——原始的结构化格式。诗歌内容是由您自行组合的各种部分(纯文本、格式化文本、脚注参考文献等)组成的列表。
  • 简化格式- 一种扁平化的格式,其中每节诗的内容都是一个字符串,脚注、诗歌和其他标记表示为该字符串中的偏移量。

选择最适合您计划如何渲染或处理文本的格式。

现有译文

GET https://bible.helloao.org/api/available_translations.json

获取 API 中可用的翻译列表。

代码示例

JavaScript
fetch-translations.js
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

结构

available-translations.ts
export interface AvailableTranslations {
    /**
     * 译文列表。
     */
    translations: Translation[];
}

interface Translation {
    /**
     * 翻译的ID。
     */
    id: string;

    /**
     * 译文名称。
     * 这通常是译文在译文语言中的名称。
     */
    name: string;

    /**
     * 译文的英文名称。
     */
    englishName: string;

    /**
     * 翻译网站。
     */
    website: string;

    /**
     * 翻译许可证的网址。
     */
    licenseUrl: string;

    /**
     * 翻译的简称。
     */
    shortName: string;

    /**
     * 翻译主要使用的 ISO 639 三字母语言标签。
     */
    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;
}

例子

/api/available_translations.json
{
    "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
fetch-books.js
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

结构

books.ts
export interface TranslationBooks {
    /**
     * 书籍的翻译信息。
     */
    translation: Translation;

    /**
     * 可供翻译的书籍清单。
     */
    books: TranslationBook[];
}

interface TranslationBook {
    /**
     * 这本书的ID。
     */
    id: string;

    /**
     * 译者为这本书提供的书名。
     */
    name: string;

    /**
     * 这本书的通用名称。
     */
    commonName: string;

    /**
     * 书名。
     * 这通常是书名的更具描述性的版本。
     * 如果没有,则表示翻译过程中没有提供相关信息。
     */
    title: string | null;

    /**
     * 译本中书籍的编号顺序。
     */
    order: number;

    /**
     * 这本书包含的章节数量。
     */
    numberOfChapters: number;

    /**
     * 本书第一章的编号。
     */
    firstChapterNumber: number;

    /**
     * 本书第一章的链接。
     */
    firstChapterApiLink: string;

    /**
     * 书中最后一章的章号。
     */
    lastChapterNumber: number;

    /**
     * 本书最后一章的链接。
     */
    lastChapterApiLink: string;

    /**
     * 这本书包含的诗节数量。
     */
    totalNumberOfVerses: number;

    /**
     * 这本书是否是伪经?
     * 如果译文为权威译文,则省略。
     */
    isApocryphal?: boolean;
}

例子

/api/BSB/books.json
{
    "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",
            "title": "Genesis",
            "order": 1,
            "numberOfChapters": 50,
            "firstChapterNumber": 1,
            "firstChapterApiLink": "/api/BSB/GEN/1.json",
            "lastChapterNumber": 50,
            "lastChapterApiLink": "/api/BSB/GEN/50.json",
            "totalNumberOfVerses": 1533
        },
    ]
}
Next
标准格式