對API請求使用失眠症

簡介

有些發現curl語句和命令行，用於我們平台API文檔中的許多示例，既困難又令人生畏。 對於這些工具，有很多工具可以將HTTP請求發送到基於REST的服務，其中包括大多數Brightcove API。 本文檔將向您展示如何使用一種流行的工具，即 Insomnia 應用.

安裝 Insomnia

獲得 Insomnia 低至 https://insomnia.rest. Insomnia 可以安裝在Mac，Linux或Windows系統上。

Insomnia 可用於向Brightcove的任何RESTful API發出請求。 大多數API使用OAuth2進行身份驗證，這就是我們將在本文檔中演示的內容。 但是，您也可以通過簡單地設置適當的標頭將其用於不使用OAuth的API。

這是帶有不同身份驗證方法的請求的標頭的外觀：

OAuth API （創建憑據請求 只能)

  Authorization: BC_TOKEN YOUR_BC_TOKEN

如何得到你的 BC_TOKEN.

Playback API

  BCOV-Policy: YOUR_POLICY_KEY

Live API

  X-API-KEY: YOUR_API_KEY

Zencoder API

  Zencoder-Api-Key: YOUR_API_KEY

獲取客戶憑證

要與大多數Brightcove API配合使用，您將需要客戶端憑證來使用您想要使用的帳戶和API。 按照以下說明獲取Studio中的客戶憑據 管理API身份驗證憑據。 在以下步驟中，我們將 Player Management API 請求使用 Insomnia，因此您的憑據至少應具有以下權限：

• Players: 讀/寫

您可以根據需要添加任意數量的其他權限，以獲得可用於更廣泛的API請求的憑據。 另外請注意，您可以根據需要獲取適用於多個帳戶的憑據。

運用 Insomnia

獲得客戶憑據後，就可以開始使用了 Insomnia。 以下步驟將引導您完成一些工作 Player Management API 請求使用 Insomnia.

設置一個 Insomnia 工作區

如果您使用其他API，則可能需要為Brightcove請求創建一個工作區。

1. 啟動 Insomnia 應用程序。
2. 點擊旁邊的下拉菜單 Insomnia 並選擇 新工作區:

   

3. 輸入名字 Brightcove公司 並點擊 創建:

   

4. 點擊 加號 並選擇 新建文件夾:

   

5. 給您的文件夾起個名字 Player Management API

發送 GET 請求

現在我們準備提出一些API請求。

註冊一個 GET 請求

1. 點擊新文件夾中的下拉菜單圖標，然後選擇 新要求:

   

2. 為請求命名 得到所有 Players，將HTTP方法保留為 GET，然後單擊創建。
3. 將通用請求網址替換為：

     https://players.api.brightcove.com/v2/accounts/account_id/players

   更換 帳戶ID 使用您自己的帳戶ID：

   

4. 展開 驗證 下拉菜單並選擇 OAuth 2.0:

   

5. 對於 撥款類型， 選擇 客戶憑證:

   

6. 輸入訪問令牌URL，客戶端ID和客戶端密鑰的值：

   OAuth條目

   訪問令牌URL	https://oauth.brightcove.com/v4/access_token
   客戶ID	您的客戶編號
   客戶機密	您的客戶秘密

7. 點擊 提取令牌 確保這有效。 您應該看到這樣的響應：

   

8. 點擊 發送:

   

9. 響應應如下所示：

   

發送 POST 請求

現在，我們將發送 POST 請求一些數據。 在這種情況下，我們將使用 Player Management API.

為此，我們將復制 得到所有 Players 要求並根據需要進行修改。 的另一個不錯的功能 Insomnia 就是當您複製請求時，所有身份驗證信息都將與它一起復制，因此您無需重新設置獲取訪問令牌的權限。

註冊一個 POST 請求

1. 點擊 Player Management API 文件夾以顯示 得到所有 Players 要求裡面。
2. 展開下拉菜單， 得到所有 Players 請求並選擇 複製:

   

3. 雙擊名稱 得到所有 Players（複製） 並將其更改為 創建 Player
4. 使用與上述GET請求步驟相同的URL，但現在選擇 POST 成為所選的HTTP方法。

   

5. 點擊 身體 展開下拉菜單並選擇 JSON:

   

6. 對於 身體 數據，請為主體輸入以下JSON代碼（JSON後的屏幕截圖顯示了請求的顯示方式）：

     {
     "name": "MySamplePlayer",
         "configuration": {
             "media": {
             "sources": [{
                 "src":"http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4",
                 "type":"video/mp4"
                 }]
             }
         }
     }
     
     

     {
         "name": "MySamplePlayer",
         "configuration": {}
     }
     
     

   

   

7. 點擊 發送.

8. 您的回復將類似於以下內容（您可以點擊 漂亮 按鈕以獲取格式更好的JSON）：

   

9. 您可以驗證您的 player 是通過簽入創建的 PlayerStudio中的s模塊。

環境變量

您可能會發現使用有幫助 Insomnia's 環境 保存用於不同API的OAuth憑據，或保存其他信息，例如您的帳戶ID和視頻或 player ID。

以下是創建和使用環境變量的步驟 client_id , client_secret 和 account_id.

1. 點擊 沒有環境 在的左上方 Insomnia 展開下拉菜單並選擇 管理環境。

   

2. 在 管理環境 對話框中，單擊 + 在旁邊簽名 子環境 展開下拉菜單，然後選擇 環境 創建一個新的環境：

   

3. 雙擊上 新環境 名稱更改為 Player Management API （或您喜歡的任何內容）。
4. 在環境JSON的花括號內，添加以下鍵/值對：
   • "account_id"“您的帳號"
   • "client_id"“您的客戶編號"
   • "client_secret"“您的客戶秘密"

   完成後，JSON應該如下所示：

   

   （出於安全原因，此處的客戶機密不明確。）

5. 點擊 完成 添加環境
6. 點擊 沒有環境 再次展開下拉菜單，然後選擇 使用方法 Player 管理環境 （或您為新環境指定的任何名稱）：

   

7. 現在選擇 得到所有 Players 再次請求重新打開它。
8. 點擊 OAuth 2 重新打開身份驗證部分。
9. 刪除客戶端ID值，然後開始輸入 CLIENT_ID -您將看到一個下拉菜單，其中顯示了相關的環境變量，您應在其中選擇 CLIENT_ID:

   

10. 現在選擇 帳戶ID 在請求網址中，然後將其替換為 帳戶ID 變量。
11. 做同樣的事情來替換 客戶機密 價值與 client_secret 變量。
12. 現在點擊 發送 再次確保請求仍然有效。

結論

您現在知道了使用的基礎知識 Insomnia 向Brightcove API發出請求。 請注意，如果您選擇升級免費 Insomnia 帳戶到團隊帳戶，您還可以同步所有請求和環境，並與其他團隊成員共享。