使用身份驗證 API

在本主題中，您將了解在使用 Brightcove 播放限制時用於管理密鑰/許可證保護的 API。

簡介

Brightcove 播放限制在將動態交付與受 DRM 保護或 HTTP 實時流加密 (HLSe) 內容一起使用時提供額外級別的安全性。

如果您不熟悉此功能，請參閱概述：Brightcove 播放限制文檔。

以下是可用於管理密鑰/許可證保護的 API：

註冊公開金鑰

您擁有私鑰，您將使用它來生成簽名令牌。您將與 Brightcove 共享公鑰以驗證您的令牌。密鑰 API 允許您使用 Brightcove 註冊您的公鑰。

關鍵 API

密鑰 API 用於管理您的公鑰與布萊特灣。

基本網址

API 的基本網址是： 

https://playback-auth.api.brightcove.com

帳號路徑

在所有情況下，我們都會針對特定的視訊雲端帳戶提出要求。因此，您將始終將術語帳戶後面跟著您的帳戶 ID 添加到基本 URL 中： 

https://playback-auth.api.brightcove.com/v1/accounts/{accountID}

授權

請求的訪問令牌是必需的，並且必須出現在授權頭። 

Authorization: Bearer {access_token}

訪問令牌是一個臨時的 OAuth2 訪問令牌，必須從布萊特灣 OAuth 服務獲得。有關如何獲取客戶端憑據並使用它們檢索訪問令牌的詳細信息，請參閱Brightcove OAuth 概述 .

權限

對 Key API 的請求必須來自客戶憑據具有以下權限：

  • video-cloud/playback-auth/key/read
  • video-cloud/playback-auth/key/write

管理金鑰

關鍵 API 支援下列要求：

註冊一個新的金鑰：

將您的公鑰的值放在 API 請求主體中。您可以在公鑰.txt文件。

API請求

POST /v1/accounts/{accountID}/keys
    Content-Type: application/json
    Body: {"value": "MFkwEwYHKoZIzj0CAQYIKoZIzj...MyeQviqploA=="}

使用捲曲

 
捲曲-X 帖子\
    -H「內容類型：應用程序/JSON」\
    -H「授權：承載人 {存取記號}」\
    -d '{"值」：「{您的公共關鍵值}"}'\
  https://playback-auth.api.brightcove.com/v1/accounts/{accountID}/keys

API 回應

{
    "id": "{your_public_key_id}",
    "type": "public",
    "algorithm": "rsa",
    "value": "{your_public_key_value}",
    "createdAt": "2020-01-03T20:30:36.488Z"
  }

列出鍵：

取得帳戶中的公開金鑰清單。 

GET /v1/accounts/{accountID}/keys

取得一個金鑰：

取得帳戶中公開金鑰的詳細資料。 

GET /v1/accounts/{accountID}/keys/{key_Id}

刪除一個鍵：

刪除帳戶中的公開金鑰。 

DELETE /v1/accounts/{accountID}/keys/{key_Id}

黑名單令牌

被列入黑名單的令牌即使被批准也不會被視為對許可證請求有效。客戶最多可以將100個令牌列入黑名單。如果100個令牌已被列入黑名單，則客戶必須刪除一個或多個令牌以為其他條目留出空間。

黑名單API

黑名單API用於管理您的令牌，這些令牌已被列入黑名單，並且對於許可請求無效。

基本網址

黑名單API的基本URL為： 

https://playback-auth.api.brightcove.com

帳號路徑

在所有情況下，我們都會針對特定的視訊雲端帳戶提出要求。因此，您將始終將術語帳戶後面跟著您的帳戶 ID 添加到基本 URL 中： 

https://playback-auth.api.brightcove.com/v1/accounts/{accountID}/blacklist

授權

請求的訪問令牌是必需的，並且必須出現在授權頭። 

Authorization:  Bearer  {access_token}

訪問令牌是一個臨時的 OAuth2 訪問令牌，必須從布萊特灣 OAuth 服務獲得。有關如何獲取客戶端憑據並使用它們檢索訪問令牌的詳細信息，請參閱Brightcove OAuth 概述 .

權限

對黑名單 API 的請求必須來自客戶憑據具有以下權限：

  • video-cloud/playback-auth/blacklist

管理列入黑名單的令牌

對黑名單的更新最多可能需要一分鐘才能在系統中傳播。黑名單API支持以下請求：

將令牌添加到黑名單：

PUT  (no  req  body)/v1/accounts/{accountID}/blacklist/tokens/{token}

整個編碼的 JWT 字符串包含在路徑中。

顯示當前黑名單：

GET  /v1/accounts/{accountId}/blacklist

檢查令牌是否在黑名單中：

GET  /v1/accounts/{accountID}/blacklist/tokens/{token}

整個編碼的 JWT 字符串包含在路徑中。

回應：

  • 204-令牌已列入黑名單
  • 404-令牌未列入黑名單

從黑名單中刪除令牌：

DELETE  /v1/accounts/{accountID}/blacklist/tokens/{token}

整個編碼的 JWT 字符串包含在路徑中。

審核帳戶

審核API可讓您針對帳戶的播放授權服務使用情況生成每日訪問報告。該報告包括詳細信息以及每個會話的授權響應。

審核API

以下是Audit API的詳細信息：

基本網址

Audit API的基本URL為： 

https://playback-auth.api.brightcove.com

帳號路徑

在所有情況下，都將請求特定的視頻雲帳戶。因此，您將始終將術語帳戶後面跟著您的帳戶 ID 添加到基本 URL 中： 

https://playback-auth.api.brightcove.com/v1/audit/accounts/{accountID}

授權

請求的訪問令牌是必需的，並且必須出現在授權頭። 

Authorization:  Bearer  {access_token}

訪問令牌是一個臨時的 OAuth2 訪問令牌，必須從布萊特灣 OAuth 服務獲得。有關如何獲取客戶端憑據並使用它們檢索訪問令牌的詳細信息，請參閱Brightcove OAuth 概述 .

權限

對 Audit API 的請求必須來自客戶憑據具有以下權限：

  • video-cloud/playback-auth/audit

產生報告

通過執行以下步驟，使用Audit API生成包含會話詳細信息的每日訪問報告：

  1. 索取每日使用情況報告

    參數

    欄位 類型 描述
    accountID 字串 您的視頻雲帳戶ID
    date 字串 驗證：
    • 格式YYYY-MM-DD
    • 日期不能是今天（UTC時間）
    • 過去的日期不能超過 30 天
    • 30天后，Brightcove不會保留授權服務使用情況報告以遵循GDPR

    請求

    方法 開機自檢
    URL https://playback-auth.api.brightcove.com/v1/audit/accounts/ {帳戶ID} /詢問/ {日期}
    標頭 授權：承載你的訪問令牌
    內容類型：應用程序/JSON

    響應

    樣本響應（200 確定）：

    {
	"executionID":  "abcdef-asfdag-dvsbcd"
}

    詳細資料：

    欄位 類型 描述
    executionID 字串 與指定的使用報告關聯的唯一 ID accountID和date .此ID傳遞到下面的其他端點。

  2. 檢查報告狀態

    請求

    方法 得到
    URL https://playback-auth.api.brightcove.com/v1/audit/accounts/ {帳戶ID} /執行/ {執行ID} /地位
    標頭 授權：承載你的訪問令牌
    內容類型：應用程序/JSON

    響應

    樣本響應（200 確定）：

    {
	"status":  "completed"
}

    詳細資料：

    欄位 類型 描述
    status 字串 值：“完成”，“正在處理”，“失敗”

  3. 提取報告

    請求

    方法 得到
    URL https://playback-auth.api.brightcove.com/v1/audit/accounts/ {帳戶ID} /執行/ {執行ID} /報告
    標頭 授權：承載你的訪問令牌
    內容類型：應用程序/JSON

    響應

    樣本響應（200 確定）：

    {
    "signedURL":  "https://signed-url",
    "expirationTime":  1569219842
}

    詳細資料：

    欄位 類型 描述
    SignedURL 字串 結果作為S3 URL返回，您可以下載
    expirationTime 時代時間戳記 簽名的S3 URL有效期為15分鐘

限制

以下限制適用於此功能的初始版本：

  • 限制為100個列入黑名單的令牌。之後，將引發錯誤。