概念：布萊特灣 API 的測試工具

在本主題中，您將了解Brightcove Learning Services提供的可幫助您測試和學習Brightcove RESTful API的工具。

工具清單

本指南中討論了以下工具：

API測試工具
測試工具 API
api-tester.sh 任何使用布萊特灣 OAuth 進行身份驗證請求的 API
在線測試儀 任何使用布萊特灣 OAuth 進行身份驗證請求的 API
失眠 任何 REST API，無論身份驗證方法如何
郵差 任何 REST API，無論身份驗證方法如何
  • 如果您正在使用 macOS 或其他 UNIX 或 LINUX 系統，或者如果您在 Windows 系統上安裝了捲曲，則可以從命令行運行的 shell 腳本
  • 可以在任何瀏覽器中使用的在線測試工具
  • 使用流行的Postman REST API測試器的指南

外殼腳本（cURL）

命令行工具是一個名為 api-tester.sh 的 shell 腳本，用於獲取訪問令牌並進行 API 調用。API 測試器腳本使用捲曲進行 HTTP 調用。捲曲是內置在 Mac MacOS 和所有 Unix /Linux 系統上。若要在視窗上取得 cURL，請參閱設定 cURL。然後下載 api-tester.sh 腳本

您可以在獲取訪問令牌中看到 shell 腳本的完整代碼。

運行shell腳本

下載Shell腳本後，將其解壓縮至所需位置，然後轉到同一文件夾中的命令行。要運行腳本，請鍵入：

	bash api-tester.sh

每次運行腳本時，它將提示您輸入5個變量：

  • 用戶端 ID (請參閱以下有關取得用戶端憑證的章節)
  • 用戶端密碼 (請參閱以下有關取得用戶端憑證的章節)
  • 完整的 API 呼叫 (範例：https://cms.api.brightcove.com/v1/accounts/12345678/videos
  • 請求動詞-以下之一：GET |發布|補丁|放置|刪除（默認為GET）
  • 請求數據-用於 POST，補丁和 PUT; 對於獲取和刪除請求，您將保留此空白，只需按返回

命令行工具將返回與在線工具相同的響應 -但是，它也會回應完整響應，如果請求由於某種原因失敗，您可以查看標題和更多信息。它還會回顯響應的原始JSON和打印精美的版本。

在線工具

在線測試工具可以在這裡找到。像命令行工具一樣，它會要求您：

  • 客戶編號
  • 客戶機密
  • 完整的API請求網址
  • 請求類型
  • 要提交的JSON數據（如果有）

失眠

請參閱使用失眠提出 API 要求的逐步指南。

郵遞員

請參閱使用郵差提出 API 要求的逐步指南。

取得認證

若要使用 Brightcove API，您將需要適當的用戶端憑證，包含client_id和client_secret .請參閱 OAuth 概觀以更好地了解客戶端憑證流程。

要獲得client_id和client_secret，您需要轉到 OAuth UI 並註冊一個應用程序：

您也可以通過 CURL 或郵遞員獲取憑據-請參閱：