使用者流程

如何瀏覽 API

作為記錄聖經大腦 API 的主要方法，我們提供包含 API 端點的 Postman 集合，按功能組織。請參閱下面的備註 核心概念 關於如何安裝和設定郵遞員。安裝 Postman 後，您可以從這裡導入來檢視該集合： 工作流程範例。

設定了「範例工作流程」集合後，您會看到一系列資料夾：

-有關語言，國家，字母，聖經書籍的一般信息
-如何找到正確的聖經（和隨附的文件集）
-一旦我擁有聖經/文件集，我該如何訪問內容？
-開放 API

每個文件夾都包含可以幫助您計劃應用程序的請求。

例如，「一般資訊」資料夾可以提供國家/地區可用的語言或聖經可用的翻譯資訊。還有端點來提供有關字母和數字系統的信息。

下一個文件夾，如何找到正確的聖經（和隨附的文件集），提供了一組語言代碼，內容類型（例如文本，音頻，視頻）的過濾器。它還提供有關聖經書訂單的一般信息，出版商信息，以及有關特定聖經可用的內容類型的詳細信息。縮小搜尋範圍後，擷取內容的關鍵就是檔案集識別碼。檢閱 核心概念 頁面，了解如何使用文件集 ID 的詳細信息。

第三個文件夾包含檢索聖經內容和必要的版權信息所需的請求。您會注意到幾乎所有內容都可以從單一端點檢索，只要您知道 FileSetID。

最終文件夾包含用於檢索聖經大腦 API 的 OpenAPI 3.0 定義的端點。這可用來產生參考文件。但是，如果您想使用其他符合 OpenAPI 的工具，端點將以 json 格式提供定義的最新版本。

‍

在設計應用程序時要提出的問題：

1. 您是否有想要使用的特定聖經和版本，還是允許最終用戶選擇一個？如果您打算為使用者提供選項，您可以查詢 API 以提供這些選項的內容。
2. 您打算僅傳遞文本，還是您希望傳遞音頻和/或視頻？如果您同時傳遞文本和音頻，並且想要「卡拉 OK」風格的同步選項，則可以訪問音頻時間端點以查找每節經文的準確開始時間。
3. 您的用戶是否會從慢速網絡訪問音頻內容？如果是，您可能想考慮使用通過 Ogg/Opus 編碼的 16kbps 音頻。測試表明對於聖經內容（例如口語和一些背景音樂）的音頻質量與 64kbps mp3 相當。