サポート サポート問い合わせ先 | システムステータス システムステータス
ページ内容

    概念:ブライトコーブAPI用のテストツール

    このトピックでは、Brightcoveラーニングサービスが提供する、Brightcove RESTful APIのテストと学習に役立つツールについて学習します。

    ツールのリスト

    このガイドでは、次のツールについて説明します。

    APIテストツール
    テストツール API
    api-tester.sh Brightcove OAuthを使用するすべてのAPI リクエストの認証
    オンラインテスター Brightcove OAuthを使用するすべてのAPI リクエストの認証
    Insomnia 認証方法に関係なく、任意のREST API
    Postman 認証方法に関係なく、任意のREST API
    • MacOSや他のUNIXシステムやLINUXシステムで作業している場合やコマンドラインから実行できるシェルスクリプト cURLがインストールされている Windowsシステムで
    • どのブラウザでも動作するオンラインテストツール
    • 人気のあるPostman REST API Testerの使用ガイド

    シェルスクリプト(cURL)

    コマンドラインツールは、 api-tester.sh トークンにアクセスしてAPI呼び出しを行います。 api-testerスクリプトは、cURLを使用してhttp呼び出しを行います。 cURLは、Mac MacOSとすべての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 | パッチ| | PUT | DELETE(デフォルトはGET)
    • リクエストデータ - POST、PATCH、およびPUTに使用されます。 GETとDELETEリクエストの場合は、これを空白のままにして、 リターン

    コマンドラインツールは、コマンドラインツールと同じ応答を返します。 オンラインツール ただし、完全な応答も返されます。何らかの理由で要求が失敗した場合は、ヘッダーと詳細情報が表示されます。 また、レスポンスのための生のJSONと、かなり印刷されたバージョンをエコーし​​ます。

    オンラインツール

    オンラインテストツールが見つかります ここ。 コマンドラインツールと同様に、次のことを要求します。

    • クライアントID
    • クライアントの秘密
    • 完全なAPIリクエストURL
    • 要求タイプ
    • 送信されるJSONデータ(存在する場合)

    Insomnia

    見ます Insomniaを使用してAPIリクエストを作成するためのステップバイステップガイド.

    Postman

    見ます Postmanを使用してAPIリクエストを作成するためのステップバイステップガイド.

    資格情報を取得する

    Brightcove APIを使用するには、適切なクライアント資格情報が必要です。 client_idclient_secret。 見る OAuthの概要 クライアントの資格情報フローをよりよく理解することができます。

    取得するには client_idclient_secretOAuthのUIにアクセスしてアプリを登録する必要があります:

    CURL または Postman を介して資格情報を取得することもできます - 以下を参照してください:


    16年2020月XNUMX日に最終更新されたページ