OAuth 指南

Brightcove創建了一個OAuth 2系統可以在我們所有新的API中使用以進行授權。本主題說明如何使用 OAuth 與播放程式管理 API 進行通訊。

簡介

您無需了解任何有關OAuth的知識即可使用該系統，我們將在下面說明您入門所需要做的一切。有關OAuth的詳細概述，請參見Brightcove OAuth API文件。

要使用OAuth身份驗證，請按照以下步驟操作：

獲取您的客戶憑證
獲取您的訪問令牌
呼叫Player Management API
要簡化步驟2和3，請使用服務器端代理

當使用Player Management API，您還可以使用基本身份驗證。有關詳細信息，請參見一步步：玩家管理文件。

獲取客戶憑證

要使用OAuth，您首先需要獲取客戶端憑據（client_id和client secret）。這些憑據對您正在使用的帳戶和API操作有效。如果您將這些憑據保存在安全的地方以備將來使用，則這是一次性操作。

有兩種獲取憑據的方法：

這是您需要權限的操作：

首選方法是使用Studio管理界面，如管理API身份驗證憑據文件。
您還可以使用cURL，如使用cURL獲取客戶端憑據文件。
1. 在Studio中：
  
  玩家管理 API 權限
2. 要通過OAuth API獲取憑據，請執行以下操作：
  - video-cloud/player/read
  - video-cloud/player/all

接下來，您將需要獲取OAuth訪問令牌。

獲取訪問令牌

您在上一步中獲得的客戶端憑據用於請求您的訪問令牌（access_token），然後提供進行API調用的授權。由於此令牌僅在5分鐘內有效，因此在大多數情況下，您需要為每次進行的API調用獲得一個令牌。

請按照以下步驟使用cURL獲取訪問令牌：

在您的命令行中，使用export命令來設置客戶端ID和客戶端密鑰的值。

    export CLIENT_ID=your client id value
              export CLIENT_SECRET=your client secret value

複製並粘貼以下 cURL 語句到您的命令行，然後按 Enter 鍵。

    curl
              -s
              --user $CLIENT_ID:$CLIENT_SECRET
              --header "Content-Type: application/x-www-form-urlencoded"
              --data "grant_type=client_credentials"
              https://oauth.brightcove.com/v4/access_token

您的回應看起來應該類似於這樣：

    {"access_token":"AGUq5IQzLzrRvs8CNbhYlBFeB1_B6jTJrcE8grFHEJaPRsPeEg3-S_Apgv8VKiZ-nzxjDGtKwAco9q3z8tdzrxq76k6B9tUXk9HYQOIYgqziWbuvA50VaW8AK2MQFc0G3-woH_kgQxNQUaVNEpE1sePE9GUb2u9FfeQyLw8XQE_QfriYwkkcQoaGOusoIpujx8H6dLFovPuH5F5N3OSxNYhNZrdOhJwkdN7oe076j3xwNRarHn5IRPYKzjOMbqDk552aAhJxo2pYWoDh3q63pBrzre4Bj1rCHKJPifPEMrgPWzG1Uz1BPhQb5_ubr4P8mtnhCjJn4zzT_1-C8ActMUof45kVFhG4VTWRA8rh05THqEBj_TzPIR7L1t5oHhLo5ziILNSp7mZRM3folvYJC6YIhY7M4qLNGR5iq3nerlv5Ufr_bI-1AnP7a68JasawDpZxjfoGf3h6cwIZJr2uG_iU4FO9Ig-Gotaqv5mLWmUgR-DJ3sfRADc",
              "token_type":"Bearer",
              "expires_in":300}

使用您的訪問令牌，您就可以與Player Management API。

呼叫Player Management API

要使用OAuth與Player Management API，則需要您在上一節中生成的訪問令牌。請記住，該令牌將在5分鐘後過期，因此，如果您的訪問令牌已過期，則可能需要重複前面的步驟。

請按照以下步驟使用cURL獲取播放器配置信息：

在您的命令行中，使用export命令來設置您的訪問令牌，帳戶ID和玩家ID的值。

    export ACCESS_TOKEN=your access token value
              export ACCOUNT_ID=your account id
              export PLAYER_ID=your player id

複製並粘貼以下 cURL 語句到您的命令行，然後按 Enter 鍵。

    curl
              --header "Content-Type: application/json"
              --header "Authorization: Bearer $ACCESS_TOKEN"
              --request GET
              https://players.api.brightcove.com/v2/accounts/{account_id}/players/{player_id}/configuration

您的回應看起來應該類似於這樣：

    {"video_cloud":{"video":null,"policy_key":"BCpkADawqM3VpA66ktTO5bdLTmz6kLGMvGZrSyp-YTvbc4MHllmDmuwzEseO1uTeYYRqygGHhB_MgMaM6ndh5ch-cKYtMFx3LerHyziID8M19b162eeIXKYaxDf8uh4OsLTxVijM-qT1N5QR"},
              "stylesheets":["https://solutions.brightcove.com/bcls/brightcove-player/disabled-scrubber/disabled-scrubber.css"],
              "scripts":[],"plugins":[],
              "player":{"template":{"version":"1.14.22","name":"single-video-template"}},
              "autoadvance":0}

要了解您可以向提出的所有請求Player Management API，請參閱Brightcove Player Management API參考文件。