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

    概述: Policy API

    在本主題中,您將學習 Policy API 是用於以及如何使用它。 的 Policy API 用於創建或獲取策略密鑰。

    簡介

    政策金鑰 用於從您的視頻中檢索視頻和播放列表內容 Video Cloud 圖書館使用 Playback API.

    另見 API參考.

    你需要一個嗎?

    在特殊情況下,您需要生成自己的策略密鑰:

    • 為生成策略密鑰 Brightcove Player創建它們時會自動。 如果您希望通過地理過濾獲取密鑰,則只需要直接使用此API生成策略密鑰 player,或訪問 Playback API 沒有創建一個 player -通常適用於使用 設備SDK。 看 策略鍵 有關如何獲取任何策略密鑰的說明 Brightcove Player.
    • 執行視頻搜索請求:
      • 您必須使用 啟用搜索的策略密鑰.
      • 為新生成的策略密鑰 Brightcove Player默認情況下未啟用。 您必須使用 Policy API.
      • 通常,啟用搜索的策略密鑰應僅存儲在服務器上,而不應存儲在瀏覽器中 player 或移動應用,因為它們可用於列出所有可播放的視頻。 對於某些帳戶,如果您不介意可以發現所有可播放的視頻,則可能不適用。
      • 搜索請求將僅返回可播放的視頻。 有關API請求/響應的詳細信息,請參見 取得影片 條的規定, Playback API 參考.

    常見問題

    以下是有關 Policy API 我們通常會得到的。

    可以為多個帳戶創建策略密鑰,還是僅為一個帳戶創建策略密鑰?
    使用策略密鑰可以訪問一個帳戶的視頻和播放列表。 如果您有多個帳戶,則需要為每個帳戶創建策略密鑰。
    策略密鑰會過期嗎?
    不,策略密鑰永遠是好的。 如果您需要撤銷策略密鑰,則必須聯繫 Brightcove支持 -在請求中包括您希望撤銷的帳戶ID和策略密鑰。
    策略密鑰是否對帳戶中的所有用戶有效?
    是的,擁有策略密鑰的任何人都可以使用它。
    可以更新策略密鑰嗎?
    否,無法更新策略密鑰。 你可以 獲取策略密鑰 從現有的 player 在您的 Video Cloud 帳戶,也可以使用 Policy API.

    基本網址

    的基本網址 Policy API 是:

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

    帳戶路徑

    在所有情況下,都將針對特定 Video Cloud 帳戶。 因此,您將始終添加 /accounts/ 然後是您的帳戶ID和基本URL:

        https://policy.api.brightcove.com/v1/accounts/{account_id}

    認證

    請求通過傳遞給服務器的訪問令牌進行身份驗證 Authorization 標頭:

        Authorization: Bearer {access_token}

    要獲取訪問令牌,請按照下列步驟操作:

    1. 獲取您的客戶憑證( client_id client_secret )通過 Video Cloud 工作室 (推薦的)。

      對於可與策略密鑰創建請求一起使用的訪問令牌,要求您的客戶端憑據在Studio中具有以下權限: Player讀和讀/寫

      驗證權限
      驗證權限

      您也可以直接通過 Brightcove公司 OAuth API.

    2. 獲得客戶憑證後,您可以 從以下位置獲取臨時訪問令牌 OAuth API.

    必需的標題

    除了 Authorization 在上一節中討論的標頭中,請求還必須具有一個 Content-Type 標頭:

        Content-Type: application/json

    創建策略密鑰

    要創建新的策略密鑰,請向以下位置發出POST請求:

        https://policy.api.brightcove.com/v1/accounts/{account_id}/policy_keys

    請求正文

    在請求主體中,包括策略的JSON:

        {
          "key-data": {
            "account-id": "{account_id}"
          }
        }

    這是最基本的策略,它限制了對帳戶的訪問,您必須在創建的任何策略中都包括該策略。 此處的帳戶ID必須與請求URL中的帳戶ID匹配,否則將返回錯誤。

    域限制

    除了限制對帳戶的訪問之外,您還可以通過添加以下內容來限制對特定域的訪問: allowed-domains 鍵:

        {
          "key-data": {
            "account-id": "123456789001",
            "allowed-domains": [
              "http://www.abc.com",
              "https://www.abc.com",
              "http://www.xyz.com",
              "https://www.xyz.com"
            ]
          }
        }

    地理限制

    Policy API 可用於為 player 代替或補充 單個視頻。

    樣本

    以下是一個白名單策略集示例,該策略集僅允許從美國,美國領土和軍事基地進行播放:

        {"account-id": "8523232323",
          "geo": {
            "countries": ["us", "usmil", "pr", "gu", "vi", "as", "mp"],
            "exclude_countries": false
          }
        }

    要將這些國家/地區列入黑名單,請設置 exclude_countries 真實。

    需要SSAI

    在使用服務器端廣告插入(SSAI)時,您可能需要一種在API請求中強制執行正確的廣告配置的方法。 您可以通過配置策略密鑰來要求 ad_config_id 作為URL參數附加到所有 Playback API 請求。

    樣本

    這是一個例子:

        {
          "key-data": {
            "account-id": "1752604059001",
            "require-ad-config": true
          }
        }

    有關使用 ad_config_id 與您的 Playback API 請求,請參閱 Playback API 概述:使用SSAI的視頻請求 文件。

    搜尋影片

    執行視頻搜索請求時,必須使用已啟用搜索的策略密鑰。 要創建啟用搜索的策略密鑰,調用的請求正文必須包括以下內容:

        {
          "key-data": {
            "account-id": "57838016001",
            "apis": ["search"]
          }
        }

    API響應

    對策略創建請求的響應將是包含加密的JSON key-string 您可以用來驗證對 Playback API,以及與金鑰相關的政策:

        {
          "key-data": {
            "account-id": "57838016001"
          },
          "key-string": "BCpkADawqM0NK0Rq8n6sEQyWykemrqeSmIQqqVt3XBrdpl8TYlvqN3hwKphBJRnkPgx6WAbozCW_VgTOBCNf1AQRh8KnmXSXfveQalRc5-pyNlSod5XzP99If2U"
        }

    政策要求

    檢索與 key-string ,發出GET請求以:

        /accounts/v1/{account_id}/policy_keys/{key_string}

    響應將是密鑰字符串和策略的JSON表示形式:

        {
          "key-data": {
            "account-id": "57838016001"
          },
          "key-string": "BCpkADawqM0NK0Rq8n6sEQyWykemrqeSmIQqqVt3XBrdpl8TYlvqN3hwKphBJRnkPgx6WAbozCW_VgTOBCNf1AQRh8KnmXSXfveQalRc5-pyNlSod5XzP99If2U"
        }

    撤銷政策

    如果您需要撤銷現有政策,請向 Brightcove支持。 在請求中包括要撤銷的策略的密鑰字符串。


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