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

    使用Postman進行API請求

    在本主題中,您將學習如何設置流行的Postman HTTP客戶端以向Brightcove RESTful API發出請求。 對於本文檔本節中的大多數示例,有些查找curl語句和命令行非常困難且令人生畏。 對於這些工具,有很多工具可以將HTTP請求發送到基於REST的服務,其中包括大多數Brightcove API。 本文檔將向您展示如何使用一種這樣的工具Postman應用程序。

    安裝 Postman

    輕松賺錢 Postman 低至 www.getpostman.com. Postman 可以作為Chrome或Mac應用安裝。 我們建議您使用桌面客戶端,但是Chrome版本可以在任何平台上運行,並且在功能和外觀上都相同。

    獲取客戶憑證

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

    • Players: Read/Write

    您可以根據需要添加任意數量的其他權限,以獲得可用於更廣泛的API請求的憑據。 還要注意,如果您願意,您會獲得適用於多個帳戶的憑據。

    您可以使用 這個在線應用 如果你比較喜歡。 如果這樣做,則需要至少指定 video-cloud/player/all 權限。

    運用 Postman

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

    設置 Postman 獲取訪問令牌

    1. 啟動 Postman 應用程序。
    2. 創建一個新請求:
      建立新要求
      建立新要求
    3. 在新的請求對話框中,輸入“獲取 Players”作為請求名稱:
      要求名稱
      要求名稱
    4. 點擊創建收藏,然後輸入“Player Management API”作為集合名稱:
      創建請求集合
      創建請求集合
    5. 保存集合。
    6. 找到 Player Management API 集合在左側列表中,然後單擊以打開新請求:
      Player Management API 系列
      Player Management API 系列
    7. 轉到 授權 標籤,選擇OAuth 2.0作為類型,並確保已選中將授權數據添加到請求標頭:
      授權科
      授權科
    8. 點擊 獲取新的訪問令牌:
      獲取新的訪問令牌
      獲取新的訪問令牌
    9. 在對話框中,輸入以下信息:
      • 令牌名稱: Player Management API
      • 撥款類型:客戶憑證
      • 訪問令牌URL: https://oauth.brightcove.com/v4/access_token
      • 客戶ID:(輸入您的客戶ID)
      • 客戶機密:(輸入您的客戶秘密)
      • 範圍: (留著空白)
      • 客戶端認證:在正文中發送客戶端憑據
      獲取訪問令牌對話框
      獲取訪問令牌對話框
    10. 點擊 請求令牌
    11. 您應該看到一個新的訪問令牌出現:
      新訪問令牌
      新訪問令牌

    發送 GET 請求

    現在,我們可以發出API請求了。

    註冊一個 GET 請求

    1. 現在,將以下網址輸入 輸入請求網址 字段,將您的帳戶ID替換為{account_id}:
      	https://players.api.brightcove.com/v2/accounts/YOUR_ACCOUNT_ID/players
      	
      	
      輸入請求網址
      輸入請求網址
    2. 將方法保留為 GET,然後點擊 發送:
      獲取請求
      GET 要求
    3. 響應應如下所示:
      GET回應
      GET回應

    發送 POST 請求

    現在我們將發送一個 POST 請求一些數據。 在這種情況下,我們將創建一個新的 player 使用 Player Management API.

    註冊一個 POST 請求

    1. 複製您的Get Player的要求:
      重複要求
      重複要求
    2. 打開您的新請求,並將其重命名為“創建 Player"
      重命名請求
      重命名請求
    3. 使用與您對網址相同的網址 GET 請求上述步驟,但現在選擇 POST 成為所選的HTTP方法。
      發布請求
      POST 要求
    4. 點擊 袋身 標籤位於網址下方,然後選擇 單選按鈕和 JSON(應用程序/ json) 從類型下拉菜單中:
      請求正文
      請求正文
    5. 您可能會注意到,新的標頭會自動添加到請求中。 發送數據的請求需要一個標頭,告知API正在發送哪種數據。 點擊 標籤以查看 Content-Type: application/json 標頭:
      添加標題
      添加標題
    6. 對於原始數據,為主體輸入以下JSON代碼(JSON之後的屏幕快照顯示了請求的顯示方式):
      	{
              "name": "Postman Test Player"
              }
      	
    7. 點擊 發送.
    8. 您的回復將類似於以下內容(您可以點擊 漂亮 按鈕以獲取格式更好的JSON):

      POST響應
      POST響應
    9. 您可以驗證您的 player 是通過簽入創建的 PlayerStudio的s部分。

    環境變量

    儘管您可以為多個帳戶和API操作的任意組合創建客戶端憑據,但您可能希望通過將憑據范圍限制為單個帳戶和API(甚至是特定的API操作)來維護更高的安全性。 如果是這樣,您可以利用 Postman's 環境變量 簡化跨多個帳戶和API的測試請求。 關鍵是設置與您使用的每組客戶端憑據相對應的環境。

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

    1. 點擊右上角的齒輪菜單 Postman 並選擇 管理環境。
      環境菜單
      環境菜單
    2. 管理環境 對話框中單擊 添加 添加環境。
    3. 對於新環境,請輸入:
      • 名稱(Brightcove APIS或您喜歡的任何名稱)
      • 一個環境變量稱為 account_id 帶有您的帳戶ID的值
      • 一個環境變量稱為 client_id 帶有您的客戶ID的值
      • 一個環境變量稱為 client_secret 帶有客戶秘密的價值
      添加環境變量
      添加環境變量
    4. 點擊 添加 添加環境
    5. 關上 管理環境 對話框返回 Postman 然後從菜單中選擇您的環境。
      選擇環境
      選擇環境
    6. 現在,您可以開始使用變量替換請求中的硬編碼值。 為此,只需鍵入 {{ 任何位置,都會顯示一個變量下拉列表:
      使用環境變量
      使用環境變量

    根據API參考創建集合

    從6.7.4版開始, Postman 支持導入OpenAPI規範以創建請求集合。 由於Brightcove的平台API參考基於OpenAPI規範,因此您可以使用此功能為任何Brightcove API生成完整的請求集合。

    在以下步驟中,我們將使用 Dynamic Ingest API 以示例為例,但是該過程適用於任何Brightcove平台API( Player API 或手機SDK,因為Postman僅支持REST API)。

    步驟

    1. 在瀏覽器中,轉到 Dynamic Ingest API 參考
    2. 點擊 Download 標題下的按鈕以下載 OpenAPI specification 對於API:
      下載OpenAPI規範
      下載OpenAPI規範
    3. 根據您使用的瀏覽器,該規範(YAML文件)可能會下載或在新的瀏覽器選項卡中打開。 如果它在瀏覽器中打開,則將內容複製並粘貼到文本文件中,或將頁面源保存到本地驅動器。 該文件應命名 openapi.yaml.
    4. 現在去 Postman 並點擊 Import 左側窗口頂部的按鈕:
      郵遞員導入按鈕
      郵遞員導入按鈕
    5. 拖放 openapi.yaml 文件從文件管理器導入到打開的導入模式中:
      郵差進口方式
      郵差進口方式
    6. Postman 處理文件,您將在標題為列表的列表中看到一個新的集合 Dynamic Ingest API Reference
      新郵遞員收藏
      新郵遞員收藏
    7. 通過向下鑽取到文件夾 accounts/{account id}/video/{video id} 您將看到以下請求:
      深入查詢
      深入查詢
    8. 點擊 POST 要求打開它。 您會發現 ParamsBody 已從API參考中預先填充,但是您需要用實際數據替換顯示數據類型的佔位符:
      預填充的參數
      預填充的參數
      預裝體
      預裝體
    9. 用適當的值替換佔位符後,就可以像創建自己的請求一樣使用該請求。

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