コンセプト:Brightcove API のテストツール
ツールのリスト
このガイドでは、次のツールについて説明します。
テストツール | API |
---|---|
api-tester.sh | リクエストの認証にBrightcove OAuth を使用する任意の API |
オンラインテスター | リクエストの認証にBrightcove OAuth を使用する任意の API |
不眠症 | 認証方法に関係なく、任意の REST API |
Postman員 | 認証方法に関係なく、任意の REST API |
- MacOSまたはその他のUNIXまたはLINUXシステムで作業している場合、または次の場合にコマンドラインから実行できるシェルスクリプトcURLがインストールされています Windowsシステムの場合
- どのブラウザでも動作するはずのオンラインテストツール
- 人気のPostmanRESTAPIテスターの使用ガイド
シェルスクリプト(cURL)
コマンドラインツールは、と呼ばれるシェルスクリプトです。 api-tester.shアクセストークンを取得してAPI呼び出しを行います。api-testerスクリプトは、cURLを使用してhttp呼び出しを行います。 cURLは、MacMacOSおよびすべてのUnix / Linuxシステムに組み込まれています。WindowsでcURLを取得するには、を参照してください。 cURLの設定。次に、 api-tester.shスクリプト
シェルスクリプトの完全なコードは、次の場所で確認できます。アクセストークンの取得。
シェルスクリプトの実行
シェルスクリプトをダウンロードしたら、好きな場所で解凍して、同じフォルダーのコマンドラインに移動します。スクリプトを実行するには、次のように入力します。
bash api-tester.sh
スクリプトを実行するたびに、次の5つの変数の入力を求められます。
- クライアントID(以下のセクションクライアント資格情報の取得について)
- クライアントシークレット(以下のセクションクライアント資格情報の取得について)
- 完全なAPI呼び出し(例:
https://cms.api.brightcove.com/v1/accounts/12345678/videos
- リクエスト動詞-次のいずれか:GET | POST |パッチ|プット| DELETE(GETがデフォルトです)
- リクエストデータ-POST、PATCH、およびPUTに使用されます。 GETおよびDELETEリクエストの場合、これを空白のままにして、を押すだけです。戻る
コマンドラインツールは、と同じ応答を返します。オンラインツール -ただし、完全な応答もエコーされるため、何らかの理由でリクエストが失敗した場合に、ヘッダーと詳細情報を確認できます。また、応答の生のJSONと、きれいに印刷されたバージョンをエコーします。
オンラインツール
オンラインテストツールは見つけることができますここに。コマンドラインツールのように、それはあなたに尋ねます:
- クライアントID
- クライアントシークレット
- 完全なAPIリクエストURL
- リクエストタイプ
- 送信するJSONデータ(ある場合)
不眠症
を参照してくださいInsomniaを使用してAPIリクエストを行うためのステップバイステップガイド。
Postman人
を参照してくださいPostmanを使用してAPIリクエストを行うためのステップバイステップガイド。
資格情報を取得する
Brightcove APIを使用するには、適切なクライアント資格情報が必要です。client_id
そしてclient_secret
。を参照してくださいOAuthの概要クライアントの資格情報の流れをよりよく理解するため。
client_id
とを取得するにはclient_secret
、OAuth UI に移動してアプリを登録する必要があります。
また、CURL または Postman 経由で資格を取得することもできます。以下を参照してください。