聖經大腦 API(也稱為「數字聖經平台」或「DBP」)是一個 RESTful API,可返回 JSON 格式的響應。讀取器應用程式所提出的所有請求都使用 HTML GET 方法。所有請求都需要提供開發人員 API 金鑰。此金鑰是在建立開發人員帳戶時提供的。
如果您已經擁有 API 金鑰,並且在過去一年內在較早版本的 DBP 上使用它,該金鑰仍可在 DBP4 上使用。
為了使用 DBP,以下是一些需要理解的核心概念。
單一聖經版本可以有多個文件集(文本,音頻,視頻,戲劇,非戲劇等)。在 BibleBrain 中,相關的文件集會按照具有相同的聖經 ID 進行分組,通常長度為六個字符,並且通常與相關文件的前六個字符匹配。但是,有些情況,字符不完全匹配,因此做出這種假設並不安全。因此,聖經 ID 通常具有 LLLVVV 格式,其中 LLL 是語言 ISO 639 代碼,而 VVV 識別聖經版本。
每個聖經由一個或多個文件集組成。檔案集是特定聖經內容的邏輯分組,包括特定大小、劇類型和媒體類型。每個檔案集都由檔案編號識別。如果您熟悉較早版本的 DBP,則 FileSetID 功能上相當於 DAMID(大多數 10 個字符的文件 setID 完全匹配對應的 v2 DAMID,其中 FileSetID 長於 10 個字符是 DBP v4 的唯一性)。
文件時間是您提供聖經內容的關鍵。其他大多數端點旨在幫助您回答這個問題:我正在尋找哪個文件時間?
檔案時間命名慣例為 LLLVVV [CDMM-xxxxx],其中包含前六個字元 通常 匹配聖經 ID 和方括號,表示可選字符。虛線後的可選字元描述用於產生音訊或視訊檔案集的媒體編碼。
例如,ENGESVN2DA 將是一個包含的文件集
-英文 (英文)
-ESV 版本(ESV)
-新約 (N)
-帶有背景音樂的多聲音(2)
-音頻(DA),作為以恆定 64kbps 比特率編碼的 mp3 文件
一般來說,以相同的前 6 個字符開頭的文件集是相同的聖經的不同格式。我們為每個聖經提供盡可能多的文件集類型,但受許可或技術限制的限制。
一個六個字符的文件集用於聖經文本(其中包含兩個約書中的所有可用書籍)。
注意:filesetid 值純粹是傳統的,旨在讓人們更輕鬆地了解與 id 相關的內容。DBP4 始終提供其他信息,準確描述內容(例如,媒體類型,戲劇/非戲劇等)。
有些文件集不完全符合慣例。因此,與 DBP2 DAMID 不同,客戶端對 FileSetID 進行解碼是不必要的,並且明確禁止。
這些全長片使用實際的福音文本作為劇本 — 逐字。由 LUMO 利用廣泛的神學、歷史和考古研究創作,每部電影都經過 Faith Comes By Hearing 的音頻經文改編,以世界各種語言的語音經文改編。
每種語言都通過一個唯一的三個字符的語言代碼來識別。這些語言代碼旨在始終匹配 ISO 639 -3 語言設置,並完全記錄在 SIL 的民族學家.
DBP 返回的語言都包含 a 語言名稱 和一個 英文名稱 領域。在許多情況下,這些字段包含相同的值,但通常, 語言名稱 欄位將包含本地化名稱。例如,對於語言代碼「CHN」, 英文名稱 欄位返回「中文、普通話」,而 語言名稱 欄位返回「中文」。
聖經的每個版本都有一個唯一的版本代碼。版本與語言不直接相關,單一版本代碼可以顯示以多種語言。例如,詹姆斯國王版本(KJV)出現在英語和泰語。
文字內容直接在 API 呼叫響應有效負載中返回。音訊和視訊內容儲存在內容傳遞網路中,而 API 回應有效負載將已簽署的 URL 傳回特定音訊或視訊檔案。
如果可用,DBP 可以提供每節經文的大致開始時間。如果您打算呈現文本和音頻的「卡拉 OK 風格」的組合,這可能會很有幫助。當您想要回應關鍵字搜索來播放音頻時,此信息也很有用。
執照 如果內容在 API 內特別標記為允許下載,則允許在應用程序中下載某些內容以供離線個人使用。API 通過 /Download/List 端點指示適用的內容。此端點需要 API 金鑰;所產生內容清單中的任何檔案集都可以透過 /download/:filesetid 端點下載。請注意,內容必須保留在應用程式內;授權允許內容僅由與 API 金鑰關聯的應用程式使用。
我們創建了一系列 API 請求範例,以幫助您更快地提高生產力。請求組織為郵遞員收藏。新增 API 金鑰後,您就可以直接從 Postman 提交請求。如果您想下載郵遞員,請點擊 這個鏈接。當您存取位於「範例工作流程」集合時,您還有機會下載 這裡。
若要執行該集合,請將其匯入個人工作區,然後在根層級設定一次 API 金鑰,在授權 (提供有關如何執行此操作的快照或兩個快照)。然後,金鑰將用於收集中的所有請求。
要請求 API 金鑰, 點擊這裡 並提供一些基本信息。