サポート問い合わせ先| システムステータス
ページコンテンツ

    APIリクエストにPostmanを使用する

    このトピックでは、人気のあるPostmanHTTPクライアントをセットアップしてBrightcoveRESTfulAPIにリクエストを送信する方法を学習します。コマンドラインでcurlステートメントを使用してリクエストを行うことができますが、これを簡単にするUIと機能を提供するアプリがいくつかあります。このドキュメントでは、そのようなツールの1つであるPostmanアプリの使用方法を説明します。

    インストール郵便配達員

    取得する郵便配達員からpostman.com。使用できるオンラインバージョンがありますが、デスクトップアプリをインストールすることをお勧めします。

    クライアント認証情報を取得する

    Brightcove API を使用するには、使用するアカウントと API のクライアント認証情報が必要です。の指示に従って、Studioでクライアント資格情報を取得しますAPI認証資格情報の管理。以下の手順では、を使用してCMS APIリクエストを作成します郵便配達員、したがって、資格情報には少なくとも次の権限が必要です。

    • Video: Read/Write

    追加のアクセス許可をいくつでも追加して、より広い範囲の API リクエストに使用できる認証情報を取得できます。また、必要に応じて、複数のアカウントで機能する資格情報が得られます。

    あなたが使用することができますこのオンラインアプリ必要に応じて。その場合、少なくとも指定する必要がありますvideo-cloud/video/all権限。

    OpenAPI仕様を入手する

    必須ではありませんが、のセットアップを大幅に簡素化できます郵便配達員使用するAPIのOpenAPI仕様をインポートすることです。これは、BrightcoveプラットフォームAPIのいずれに対しても実行できますが、このチュートリアルでは、CMS APIを使用します。

    OpenAPI仕様を取得するには、 CMS APIリファレンスをクリックしますダウンロードボタン:

    Download OpenAPI Spec
    OpenAPI仕様をダウンロードする

    ダウンロードしたファイルはopenapi.yaml

    OpenAPI仕様をインポートする

    次のステップは、Postmanアプリを起動し、ダウンロードしたOpenAPI仕様をインポートすることです。

    コレクションを設定する

    API仕様がインポートされたので、リクエストのコレクションを生成できます。

    1. クリックAPI
    2. 他のAPIがある場合は、 Brightcove CMS APIリファレンス
    3. クリックコレクションを生成する
      Generate Collection
      コレクションを生成する
    4. 表示されるダイアログで、「BrightcoveCMS API」のようなコレクションの名前を入力します。
    5. 選択するAPIをテストします「このAPIをどのように使用しますか?」の下にあります。
    6. クリックコレクションを生成する
      Collection Settings
      コレクションの設定
    7. を開きますコレクション新しいCMS APIコレクションをクリックします。
    8. コレクションを展開し、をクリックしますビデオフォルダを選択し、ビデオを入手リクエスト。
      CMS API Collection
      CMS APIコレクション
      Request Details
      リクエストの詳細

    Postmanは、リクエスト自体やそれに追加できるパラメータなど、APIリファレンスからほとんどの詳細を設定していることに注意してください。さらに、あなたはクリックすることができますドキュメンテーション APIリファレンスからのリクエストのドキュメントを表示する右側のアイコン:

    Show Documentation
    ドキュメントを表示
    Request Documentation
    ドキュメントをリクエストする

    ただし、アカウントIDや認証情報など、独自の情報を提供する必要があります。これはリクエストごとに行うことができますが、より良い方法は環境リクエストの場合、一般的に使用される情報を変数として保存できます。次のセクションでそれを行います。

    環境を作る

    以下の手順では、CMS APIリクエスト用の環境を設定する手順を説明します。

    1. クリック環境、 その後環境を作る
      Create Environment
      環境を作る
    2. 環境に「BrightcoveAPI」のような名前を付けます(この環境を他のBrightcove APIにも使用でき、必要に応じて新しい変数を追加できます)。
    3. 「新しい変数を追加」というテキストをクリックして、次のように入力しますアカウントID、次にクリックします初期値フィールドに入力し、VideoCloudアカウントIDを入力します。
      Enter Variable
      変数を入力してください
    4. 前の手順を繰り返して、変数を追加します。
      環境変数
      可変 初期値
      クライアントID (クライアントID-を参照してくださいクライアントの資格情報を取得するその上)
      client_secret (クライアントの秘密-参照クライアントの資格情報を取得するその上)
      access_token_url https://oauth.brightcove.com/v4/access_token
    5. クリックセーブ環境を保護するには:
      Save Environment
      環境を保護する
    6. Brightcove CMS APIコレクションに戻り、環境セレクターから作成した環境を選択します。
      Environment Selector
      環境セレクター

    環境変数は、二重中括弧で囲むことで参照できます-例:{{client_id}}。Postmanは、「{{...」と入力するとオートコンプリートを支援します。に戻ってこれを試すことができますビデオを入手リクエストして、「{{a」と入力し始めます。価値パス変数のフィールドアカウントID

    Variable Autocompletion
    可変オートコンプリート

    リクエストを有効にする

    環境が設定されたので、変数を使用してリクエストをテストできます。まず、GetVideosリクエストを見ていきます。

    1. まだ行っていない場合は、次のように入力します{{account_id}}の値についてアカウントIDパス変数
    2. クリック承認リクエストのタブ:
      Auth Tab
      [認証]タブ
    3. 構成オプション、 変更付与タイプクライアント-クレデンシャル
      Auth Grant Type
      認証付与タイプ
    4. 環境から次の変数を適切なフィールドに入力します。
      • アクセストークンのURL:{{access_token_url}}
      • クライアントID:{{client_id}}
      • クライアントシークレット:{{client_secret}}
    5. クリック新しいアクセストークンを取得する
      Authorization Setup
      承認の設定
    6. 認証が完了したら、クリックできます続行または、トークンが表示されるのを待ちます。次に、をクリックしますトークンを使用する
      Manage Access Tokens
      アクセストークンの管理

    Brightcoveアクセストークンは5分後に期限切れになることに注意してください。実行していることとその速度によっては、同じアクセストークンを数回使用できる場合があります。有効期限が切れると、CMS APIは不正なエラーを返します。

    [
    	{
    			"error_code": "UNAUTHORIZED",
    			"message": "Permission denied."
    	}
    ]

    (メッセージの正確な形式は他のAPIによって異なる場合がありますが、同様になります。)

    これが発生した場合は、単に承認タブをクリックして、新しいトークンをリクエストします。また、期限切れのトークンはそれ以上の価値がないため、混乱を避けるために削除する必要があります。

    Delete Expired Tokens
    期限切れのトークンを削除する

    リクエストする

    これで、GetVideosリクエストを行う準備ができました。

    1. に戻るパラメータタブを選択し、すべてのクエリパラメータのチェックを外します(もちろん、それらを使用して値を変更できますが、この最初のテストではデフォルト値を使用します)。
    2. [ 送信 ] をクリックします。
    3. 下の応答領域(ビデオメタデータオブジェクトの配列)にJSONコードが表示されるはずです。
      Response Data
      応答データ
    4. 次に、書き込みリクエスト(ビデオの作成)を試します。コレクションからそのリクエストを選択します。
      Create Video Request
      ビデオリクエストの作成
    5. もう一度入力する必要がありますのためにアカウントIDパス変数。あなたはするであろうない Postmanはこれらの設定をコレクション内の他のリクエストに転送するため、認証を設定するには前のセクションの手順を繰り返す必要があります。しかしながら、それでも、新しいアクセストークンを生成する必要があります
    6. 次に、タブ。APIリファレンスからのサンプルリクエスト本文が表示されます。
      Sample Request Body
      リクエスト本文の例
    7. このJSONは編集可能です。動画の作成リクエストに必要なフィールドは、名前、その値を「Test Video」に変更し、JSONの残りの部分を削除して、リクエストの本文が次のようになるようにします。
      {
      	"name": "Test video"
      }
    8. 次に、[送信]をクリックし(必要に応じて新しいアクセストークンを取得します)、新しいビデオのメタデータオブジェクトが応答領域に表示されます。

    ページの最終更新日22 Sep 2021