快速開始： Ingest Profiles API

簡介

Ingest Profiles API 允許您：

• 獲取您的帳戶資料

• 建立新的設定檔

• 更新資料

• 刪除個人資料

• 設置或更新您帳戶的默認配置文件

寧靜的API

Ingest Profiles API 是RESTful API。 它接受HTTPS請求並返回JSON響應。

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

基本網址

的基本網址 Ingest Profiles API 是：

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

授權

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

    Authorization: Bearer {access_token}

訪問令牌很短-lived（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，您可以使用：

• 名稱（例如，平衡高清）
• generated id (e.g. 54de14cce4b0a6d2bf9cb08a)

例子：

    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，您可以使用：

• 名稱（例如，平衡高清）
• generated id (e.g. 54de14cce4b0a6d2bf9cb08a)

示例：

    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，您可以使用：

• 名稱（例如，平衡高清）
• generated id (e.g. 54de14cce4b0a6d2bf9cb08a)

示例：

    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}
    }

與其他操作一樣，您可以將名稱或ID用作 profile_id.

• 名稱（例如，平衡高清）
• generated id (e.g. 54de14cce4b0a6d2bf9cb08a)

示例：

    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。 如果沒有默認配置文件，請參閱 設置默認配置文件。 與其他操作一樣，您可以將名稱或ID用作 profile_id.

• 名稱（例如高分辨率）
• generated id (e.g. 54de14cce4b0a6d2bf9cb08a)

示例：

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

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

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

提交申請

（響應將出現在下一張幻燈片上）

練習8的反應