快速入門：內嵌設定檔 API

簡介

「內嵌設定檔 API」可讓您：

• 取得您帳戶的設定檔

• 建立新設定檔

• 更新設定檔

• 刪除設定檔

• 設定或更新帳戶的預設設定檔

一個寧靜的 API

內嵌設定檔 API 是一個 RESTful API。它接受 HTTPS 請求並返回一個 JSON 響應。

這意味著您可以將 API 與您選擇的任何語言一起使用-紅寶石，Java，PHP，Python，JavaScript（通過 AJAX 或節點）等。你所要做的就是發出 HTTPS 請求並處理 JSON 響應。

基本網址

Ingest Profiles API的基本URL是：

    https://ingestion.api.brightcove.com/v1

授權

API 調用是使用 OAuth2 訪問令牌進行授權的。令牌與授權標頭中的請求一起傳遞：

    Authorization: Bearer {access_token}

訪問令牌是短暫的（5 分鐘），所以每次提出請求時都必須得到一個

在這些練習中，我們將通過代理這將獲取訪問令牌，然後發出請求。

練習設置

獲取所有個人資料

獲取帳戶資料

要獲取帳戶的所有配置文件，請向端點發出GET請求：

    /accounts/{account_id}/profiles

範例：

    https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles

練習1：取得所有設定檔

發出以下GET請求：

提交請求

建立個人資料

創建配置文件

要創建配置文件，請向端點發出POST請求：

    /accounts/{account_id}/profiles

範例：

    https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles

配置文件的JSON包含在請求正文中。見配置文件字段參考用於配置文件，格式轉換和DRM軟件包字段

練習2：建立設定檔

發出以下POST請求：

提交請求

(回覆將會出現在下一張投影片)

練習2的反應

獲取一個個人資料

通過ID獲取個人資料

要通過ID檢索配置文件，請向端點發出GET請求：

    /accounts/{account_id}/profiles/{profile_id}

對於profile_id，您可以使用以下任一：

• 名稱（例如平衡高清晰度）
• 產生的識別碼 (例如：

範例：

    https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/screencast
    https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/54de14cce4b0a6d2bf9cb08a

練習3：取得一個個人資料

發出以下GET請求以取回您創建的配置文件：

提交請求

更新資料

通過ID更新個人資料

要通過ID更新配置文件，請向端點發出PUT請求：

    /accounts/{account_id}/profiles/{profile_id}

對於profile_id，您可以使用以下任一：

• 名稱（例如平衡高清晰度）
• 產生的識別碼 (例如：

範例：

    https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/my-test-profile

就像創建概要文件一樣，將概要文件數據包括在請求正文中。個人資料數據必須包括id為個人資料！

練習4：更新配置文件

發出以下PUT請求以更新您創建的配置文件（描述將被更新）：

提交請求

(回覆將會出現在下一張投影片)

練習4回應

刪除個人資料

按ID刪除個人資料

要通過ID刪除配置文件，請向端點發出DELETE請求：

    /accounts/{account_id}/profiles/{profile_id}

對於profile_id，您可以使用以下任一：

• 名稱（例如平衡高清晰度）
• 產生的識別碼 (例如：

範例：

    https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/my-test-profile

練習5：刪除設定檔

發出以下DELETE請求以更新您創建的配置文件（無法撤消！）：

提交請求

獲取默認配置文件

取得預設設定檔

要獲取該帳戶的默認配置文件，請向端點發出GET請求：

    /accounts/account_id/configuration

範例：

    https://ingestion.api.brightcove.com/v1/accounts/57838016001/configuration
                        

練習6：獲取默認配置文件

發出以下GET請求以獲取該帳戶的默認配置文件：

提交請求

設置默認配置文件

設定預設設定檔

要設置該帳戶的默認配置文件，請向端點發出POST請求：

    /accounts/account_id/configuration

包含此 JSON 作為請求主體

    {
      "account_id": {account_id},
      "default_profile_id": {default_profile_id}
    }

與其他操作一樣，您可以使用profile_id .

• 名稱（例如平衡高清晰度）
• 產生的識別碼 (例如：

範例：

    https://ingestion.api.brightcove.com/v1/accounts/57838016001/configuration
                        

練習7：設置默認配置文件

發出以下POST請求以設置默認配置文件（請注意，如果該帳戶已經具有默認配置文件，則此操作將失敗-我們將在下一個練習中更新默認配置文件）：

提交請求

(回覆將會出現在下一張投影片)

練習7回應

更新默認配置文件

更新預設設定檔

要更新帳戶的默認配置文件，請向端點發出PUT請求：

    /accounts/account_id/configuration

包含此 JSON 作為請求主體

    {
      "id": {configuration_id},
      "account_id": {account_id},
      "default_profile_id": {default_profile_id}
    }

獲取默認配置文件時，將返回配置ID。如果沒有默認配置文件，請參閱設置默認配置文件。與其他操作一樣，您可以使用profile_id .

• 名稱（例如高分辨率）
• 產生的識別碼 (例如：

範例：

    https://ingestion.api.brightcove.com/v1/accounts/57838016001/configuration
                        

練習8：更新默認配置文件

發出以下PUT請求以更新該帳戶的默認配置文件：

提交請求

(回覆將會出現在下一張投影片)

練習8回應