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

インストール Postman

取得する Postman from www.getpostman.com. Postman ChromeまたはMacアプリとしてインストールできます。 デスクトップクライアントを入手することをお勧めしますが、Chromeバージョンはどのプラットフォームでも動作し、機能と外観は同じです。

クライアントの資格情報を取得する

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

• Players: Read/Write

より多くの追加のアクセス許可を追加して、より広範なAPI要求に使用できる資格情報を取得することができます。 また、必要に応じて複数のアカウントで動作する資格情報を取得することにも注意してください。

あなたが使用することができます このオンラインアプリ もしあなたが好きなら。 あなたがそうするならば、少なくとも指定する必要があります video-cloud/player/all パーミッション。

使い方 Postman

クライアントの資格情報を取得すると、使用を開始する準備が整います Postman。 以下の手順では、いくつかの Player Management API リクエストを使用して Postman.

セットアップ Postman アクセストークンを取得する

1. 起動する Postman アプリ。
2. 新しいリクエストを作成する：

   

3. 新しいリクエストダイアログで、「Get Playerリクエスト名のs "：

   

4. [コレクションの作成]をクリックして、Player Management API"コレクション名：

   

5. コレクションを保存します。
6. 見つける Player Management API コレクションを左のリストに追加してクリックすると、新しいリクエストが開きます：

   

7. に行きます 承認 []タブをクリックし、[OAuth 2.0]をタイプとして選択し、[認証ヘッダーを要求ヘッダーに追加]が選択されていることを確認します。

   

8. ナビゲーションヘッダーの 新しいアクセストークンを取得する:

   

9. ダイアログで、以下の情報を入力します。
   • トークン名: Player Management API
   • 交付金の種類：クライアント資格情報
   • アクセストークンURL: https://oauth.brightcove.com/v4/access_token
   • 顧客ID：（お客様のクライアントIDを入力してください）
   • クライアントシークレット：（クライアントシークレットを入力してください）
   • 範囲:(空白のまま）
   • クライアント認証：クライアント資格情報を本文で送信します

   

10. ナビゲーションヘッダーの リクエストトークン
11. 新しいアクセストークンが表示されます。

    

送信 GET 要求

これで、APIリクエストを行う準備が整いました。

作る GET 要求

1. 次のURLを リクエストURLを入力 {account_id}にあなたのアカウントIDを代入してください：

   	https://players.api.brightcove.com/v2/accounts/YOUR_ACCOUNT_ID/players
   	
   	

   

2. メソッドをそのまま GET、クリック 送信:

   

3. 応答は次のようになります。

   

送信 POST 要求

今すぐ POST いくつかのデータを要求します。 この場合、新しい player Player Management API.

作る POST 要求

1. Getを複製する Playersリクエスト：

   

2. 新しいリクエストを開き、名前を「作成 Player"

   

3. あなたと同じURLを使用してください GET 上記の手順をリクエストしてください POST 選択されたHTTPメソッドになります。

   

4. ストリーミングを停止する場合は上部の ボディ URLのすぐ下にあるタブをクリックして 生 ラジオボタンと JSON（アプリケーション/ json） タイプドロップダウンメニューから：

   

5. 新しいヘッダーがリクエストに自動的に追加されることに注意してください。 データを送信する要求には、APIにどのような種類のデータが送信されているかを示すヘッダが必要です。 クリック ヘッダ タブをクリックして Content-Type: application/json ヘッダ：

   

6. 生データの場合、本文に次のJSONコードを入力します（JSONの後のスクリーンショットは、リクエストの表示方法を示しています）。

   	{
           "name": "Postman Test Player"
           }
   	

7. ナビゲーションヘッダーの 送信.

8. 応答は次のようになります（クリックして かわいいです より適切にフォーマットされたJSONのボタン）：

   

9. あなたはそれを確認することができます player チェックインして作成されました Playerスタジオのセクション。

環境変数

複数のアカウントとAPI操作の任意の組み合わせに対してクライアント認証情報を作成できますが、認証情報の範囲を単一のアカウントとAPI（または特定のAPI操作）に制限することにより、より高いセキュリティを維持したい場合があります。 もしそうなら、あなたは利用することができます Postman's 環境変数 複数のアカウントとAPIにわたるリクエストのテストを簡素化します。 重要なのは、使用するクライアント資格情報の各セットに対応する環境をセットアップすることです。

以下は、環境変数を作成および使用するための手順です。 client_id , client_secret .

1. 右上の歯車メニューをクリックします Postman をクリックして 環境を管理する。

   

2. の中に 環境を管理する ダイアログ、クリック 追加 環境を追加します。
3. 新しい環境では、次のように入力します。
   • 名前（Brightcove APIS、または好きなもの）
   • 呼び出される環境変数 account_id あなたのアカウントIDの値で
   • 呼び出される環境変数 client_id あなたのクライアントIDの値で
   • 呼び出される環境変数 client_secret クライアントの秘密の価値を持つ

   

4. ナビゲーションヘッダーの 追加 環境を追加する
5. それを閉めて 環境を管理する ダイアログに戻る Postman メニューから環境を選択します。

   

6. これで、ハードコードされた値を変数に置き換えることができます。 これを行うには、 {{ どこにでも、変数のドロップダウンリストが表示されます。

   

APIリファレンスからコレクションを作成する

バージョン6.7.4以降、 Postman リクエストコレクションを作成するOpenAPI仕様のインポートをサポートしています。 BrightcoveのプラットフォームAPIリファレンスはOpenAPI仕様に基づいているため、この機能を使用して、任意のBrightcove APIに対するリクエストの完全なコレクションを生成できます。

以下の手順では、 Dynamic Ingest API 例として、この手順は任意のBrightcoveプラットフォームAPI（Studio上ではサポートされていません。 for Player API またはモバイルSDK（PostmanはREST APIのみをサポートしているため）。

ステップ

1. あなたのブラウザで、に行きなさい Dynamic Ingest API 参照
2. クリックします。 ダウンロード タイトルの下のボタンをクリックしてダウンロードします。 OpenAPI仕様 APIの場合：

   

3. 使用しているブラウザによっては、仕様（YAMLファイル）がダウンロードされるか、新しいブラウザタブで開く場合があります。 ブラウザで開いた場合は、コンテンツをコピーしてテキストファイルに貼り付けるか、ページソースをローカルドライブに保存します。 ファイル名は openapi.yaml.
4. さあ行く Postman をクリックして インポート 左側のウィンドウ上部のボタン：

   

5. ドラッグアンドドロップ openapi.yaml ファイルマネージャからインポートモーダルにファイルを開きます。

   

6. 後の Postman ファイルを処理すると、タイトルのリストに新しいコレクションが表示されます。 Dynamic Ingest API 参照

   

7. フォルダへのドリルダウン accounts/{account id}/video/{video id} そして、あなたは要求を見るでしょう：

   

8. 現在地に最も近い POST 開くように要求してください。 あなたは両方を見つけるでしょう Params と ボディ APIリファレンスからあらかじめ入力されていますが、データ型を示すプレースホルダーを実際のデータに置き換える必要があります。

   

   

9. プレースホルダーを適切な値に置き換えたら、自分で作成したものと同じようにリクエストを使用できます。