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

Postmanのインストール

postman.com から Postman を入手します。オンライン版もありますが、デスクトップアプリをインストールすることをお勧めします。

クライアント認証情報の取得

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

• Video: Read/Write

より幅広いAPIリクエストで使用可能なクレデンシャルを取得するために、好きなだけ権限を追加することができます。また、お望みであれば、複数のアカウントで使えるクレデンシャルを取得できることにも注意してください。

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

OpenAPI仕様の所得

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

Open API仕様を取得するには、 CMS APIリファレンスにアクセスし、ダウンロードボタンをクリックして下さい：

ダウンロードしたファイルはopenapi.yamlと呼ばれます。

OpenAPI仕様の取得

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

コレクションを開く

APIがインポートされると、Postmanはリクエストのコレクションを生成します。

1. コレクションをクリックします。
2. 新しいCMS APIコレクションを選択します:
3. コレクションを展開し、Videoフォルダをクリックし、Get Videos リクエストを選択します。

   

   

PostmanはAPIリファレンスから、リクエスト自体やリクエストに追加できるパラメータなど、ほとんどの詳細をセットアップしてくれています。また、パラメータに関するドキュメントも提供し、値を編集したり、リクエストと一緒に送信したくないパラメータのチェックを外したりすることができます。

しかし、アカウントIDや認証情報など、自分でいくつかの情報を提供する必要があります。リクエストごとに、これを行うこともできますが、より良い方法は、リクエスト用の 環境 を作り、そこでよく使われる情報を変数として保存することです。次のセクションでそれを行います。

環境を作る

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

1. Environment Quick Look アイコンをクリックし、Add をクリックします：

   

2. 環境名を編集し、「Brightcove API」に変更します。（必要に応じて新しい変数を追加し、この環境を他のBrightcove APIにも使用できる様にします）。
3. 「Add a new variable」というテキストをクリックして、account_id と入力し INITIAL VALUEフィールドをクリックして、Video CloudアカウントIDを入力します(次にCURRENT VALUEも同様に入力します):

   

4. 前の手順を繰り返して、変数を追加します。

   環境変数

   変数	初期値
   client_id	（クライアントID - 上記のクライアントの資格情報を取得するを参照して下さい）
   client_secret	（クライアント シークレット - 上記のクライアントの資格情報を取得するを参照して下さい）
   access_token_url	https://oauth.brightcove.com/v4/access_token

5. Saveをクリックして環境を保存します：

   

6. Brightcove CMS APIコレクションに戻り、環境セレクターから作成した環境を選択します:

   

環境変数は、二重中括弧で囲むことで参照できます - 例：{{client_id}}。Postmanは、"{{..."と入力すると自動補完してくれます。Get Videos リクエストにに戻って、パス変数account_id の Valueフィールドに"{{a"と入力してみて下さい：

リクエストを有効にする

これで環境が設定されたので、リクエストに変数を使用する事ができます。まず、Get Videosリクエストを見てみましょう。

1. まだ入力していない場合は、account_id パス変数の値に{{account_id}}を入力します。
2. リクエストのAuthorization タブをクリックします：

   

3. Configuration Optionsで、Grant Type を Client Credentials に変更します：

   

4. お使いの環境から以下の変数を適切なフィールドに入力します:
   • Access Token URL：{{access_token_url}}
   • Client ID：{{client_id}}
   • Client Secret：{{client_secret}}
5. Get New Access Token をクリックします：

   

6. 認証が完了したら、Proceed をクリックするか、トークンが表示されるまで待ちます。次に Use Token をクリックします：

   

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

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

（メッセージの正確な形式は他のAPIでは異なる場合がありますが、似たようなものになるでしょう。）

このような場合は、Authorizationタブをクリックして、新しいトークンをリクエストします。また、混乱を避けるために、期限切れのトークンも削除してください。

リクエストする

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

1. Paramsタブに戻り、Query Paramsのチェックをすべて外します（もちろん、値を変更して使用することもできますが、この最初のテストではデフォルト値を使用します）。
2. Send をクリックします。
3. 下のレスポンス・エリアにJSONコードが表示されるはずです。（ビデオ・メタデータ・オブジェクトの配列):

   

4. 次に、書き込みリクエスト（Create Video）を試します。コレクションからそのリクエストを選択します。

   

5. Account ID Path Variableに再度入力する必要があります。Postmanはこれらの設定をコレクション内の他のリクエストに転送するため、前のセクションの認証設定を繰り返す必要はありません。ただし、新しいアクセストークンを生成する必要があります。
6. 次に、Bodyタブに行き、APIリファレンスにあるリクエストボディのサンプルが表示されます。

   

7. このJSONは編集可能です。Create Video リクエストの必要なフィールドは、nameだけなので、その値を「Test Video」に変更し、残りのJSONを削除して、リクエストの本文が次のようになるようにします。

   {
   	"name": "Test video"
   }

8. 次に、[Send]をクリックすると（必要に応じて新しいアクセストークンを取得します）、新しいビデオのメタデータ・オブジェクトがレスポンスエリアに表示されるはずです。

関連トピック

• Brightcove API のテストツール
• API リクエストの認証
• オンラインAPIテスター
• API リクエストにInsomniaを使用する