支持 聯繫支持 | 系統狀況 系統狀態
頁面內容

    概述: Delivery System API

    在本主題中,您將獲得有關 Delivery System API,用於管理和部署一組稱為存儲庫的文件。 該系統已設置為 player 相關文件,例如自定義插件的JavaScript和CSS文件。

    概述

    與交付系統關聯的文件是通過REST API以及(可選)通過Git管理的。 這些文件被傳送到 players.brightcove.net 通過API調用或“ git push”。

    如果您還沒有經歷過 一步步: Delivery System API,強烈建議您從此處開始。 您將設置安全性,學習系統的一些基礎知識,然後準備在此處進一步深入。

    另見 API參考.

    交付系統REST API

    交付系統API以存儲庫(也稱為存儲庫)為中心。 您可以通過一組REST API來管理倉庫,這些REST API允許您添加,獲取和列出倉庫。 您還可以使用REST API調用來處理存儲庫中的文件。

    您可以使用命令行工具curl來使用REST API。 REST API以JSON格式返迴響應,其中包含以下有關成功的信息:

    • name:回購名稱。 這與在REST API URL中找到的名稱相同。
    • public_url:可以看到回購文件的基本URL。

    分步:交付系統 提供了使用指南的動手指南 Delivery System APIs.

    認證

    您可以使用以下任一方法授權自己 OAuth訪問令牌 或使用您的Brightcove用戶名和密碼通過基本身份驗證。 標準的OAuth訪問令牌應用於API的任何編程用途,但是對於命令行使用和入門而言,基本身份驗證路由要容易得多。

    我們將在 一步步 例子。 如果您想使用訪問令牌,請更改:

        --user $EMAIL

    到:

        --header "Authorization: Bearer $ACCESS_TOKEN"

    API錯誤響應

    REST API調用出現問題時,有許多可能的錯誤響應可以JSON格式返回:

    • 如果您嘗試調用一個不存在的API(包括拼寫現有的API調用),則會收到狀態碼404和有關您可能做錯了什麼的有用消息。
    • 如果您的呼叫無法通過身份驗證或授權,您將獲得403狀態代碼。 請嘗試再次查看OAuth指南,以確保您擁有有效的訪問令牌。
    • 如果您嘗試使用GET或PUT以外的方法,則響應將包含405狀態代碼。
    • 如果處理您的請求有問題,您將獲得500狀態代碼和標準的Brightcove錯誤響應。

    上面提到的標準Brightcove錯誤響應是一個包含error_code和message屬性的JSON響應。 錯誤代碼將是以下之一:

    • INVALID_LOGIN_CREDENTIALS:使用基本身份驗證時提供的用戶名和密碼無效
    • ACCESS_TOKEN_ERROR:給出的訪問令牌無效
    • INVALID_API_CALL:API調用的格式不正確
    • NOT_FOUND:API調用未指向已知資源或未正確格式化
    • NO_PUT_CONTENTS:必須使用包含內容密鑰的多部分錶單來放置回購文件
    • CREATE_REPO_ERROR:創建存儲庫時發生錯誤
    • GET_REPO_ERROR:獲取回購時發生錯誤
    • GET_REPOS_ERROR:獲取所有存儲庫時發生錯誤
    • UNCAUGHT_ERROR:未捕獲的錯誤導致失敗
    • UNKNOWN_ERROR:發生了沒有相關錯誤代碼的錯誤

    限制


    頁面最後更新於12年2020月XNUMX日