API リクエストにインソムニアを使用する

はじめに

プラットフォームAPIドキュメントの多くの例で使用されているcurlステートメントとコマンドラインは、難しくて威圧的であると感じる人もいます。このような場合、ほとんどのBrightcove API を含む REST ベースのサービスに HTTP リクエストを送信するためのツールが多数用意されています。このドキュメントでは、人気のあるツールの1つであるInsomniaアプリ。

インストールInsomnia

取得するInsomniaからhttps://insomnia.rest。Insomnia Mac、Linux、またはWindowsシステムにインストールできます。

Insomnia BrightcoveのRESTfulAPIのいずれかにリクエストを送信するために使用できます。ほとんどのAPIは認証にOAuth2を使用します。これを、このドキュメントで説明します。ただし、適切なヘッダーを設定するだけで、OAuthを使用しないAPIにも使用できます。

さまざまな認証方法を使用したリクエストのヘッダーは次のようになります。

OAuth API（資格情報リクエストの作成のみ）

  Authorization: BC_TOKEN YOUR_BC_TOKEN

あなたを取得する方法BC_TOKEN。

Playback API

  BCOV-Policy: YOUR_POLICY_KEY

Live API

  X-API-KEY: YOUR_API_KEY

Zencoder API

  Zencoder-Api-Key: YOUR_API_KEY

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

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

• プレイヤー：読み書き

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

Insomnia を使用する

クライアントの資格情報を取得したら、使用を開始する準備ができていますInsomnia。以下の手順では、いくつかの作成について説明しますプレーヤー管理APIを使用したリクエストInsomnia。

の設定Insomniaワークスペース

他のAPIを使用する場合は、Brightcoveリクエスト専用のワークスペースを作成することをお勧めします。

1. を起動しますInsomniaアプリ。
2. 横のドロップダウンをクリックしますInsomnia選択します新しいワークスペース：

   

3. 名前を入力してくださいBrightcove をクリックします作成する：

   

4. クリックプラス記号選択します新しいフォルダ：

   

5. フォルダに名前を付けますPlayer Management API

GETリクエストを送信

これで、いくつかのAPIリクエストを行う準備ができました。

GETリクエストする

1. 新しいフォルダのドロップダウンメニューアイコンをクリックして、新しいリクエスト：

   

2. リクエストに名前を付けますすべてのプレイヤーを取得、HTTPメソッドはそのままにしますGET、[作成]をクリックします。
3. 一般的なリクエストURLを次のように置き換えます。

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

   交換アカウントID自分のアカウントIDで：

   

4. を展開します認証ドロップダウンメニューを選択し、 OAuth 2.0：

   

5. のために付与タイプ、 選択するクライアント資格情報：

   

6. アクセストークンのURL、クライアントID、およびクライアントシークレットの値を入力します。

   OAuthエントリ

   アクセストークンのURL	https://oauth.brightcove.com/v4/access_token
   クライアントID	クライアントID
   クライアントの秘密	あなたのクライアントの秘密

7. クリックトークンを取得するこれが機能することを確認します。次のような応答が表示されます。

   

8. クリック送信：

   

9. レスポンスは次のようになります。

   

POSTリクエストを送信

今、私たちは送信しますPOSTいくつかのデータを要求します。この場合、Player ManagementAPIを使用して新しいビデオオブジェクトを作成します。

これを行うために、すべてのプレイヤーを取得必要に応じてリクエストして変更します。のもう一つの素晴らしい機能Insomniaつまり、リクエストを複製すると、すべての認証情報が一緒に複製されるため、アクセストークンの取得を再度設定する必要はありません。

POSTリクエストする

1. クリックしてくださいプレーヤー管理API表示するフォルダすべてのプレイヤーを取得その中のリクエスト。
2. のドロップダウンメニューを展開しますすべてのプレイヤーを取得リクエストして選択複製：

   

3. 名前をダブルクリックしますすべてのプレーヤーを取得（コピー）に変更しますプレーヤーを作成する
4. 上記のGETリクエスト手順で使用したのと同じURLを使用しますが、ここで選択しますPOST選択されたHTTPメソッドになります。

   

5. クリック体ドロップダウンメニューを展開して、 JSON：

   

6. のために体データの場合、本文に次のJSONコードを入力します（JSONに続くスクリーンショットは、リクエストがどのように表示されるかを示しています）。

     {
     "name": "MySamplePlayer",
         "configuration": {
             "media": {
             "sources": [{
                 "src":"http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4",
                 "type":"video/mp4"
                 }]
             }
         }
     }
     
     

     {
         "name": "MySamplePlayer",
         "configuration": {}
     }
     
     

   

   

7. [ 送信 ] をクリックします。

8. レスポンスは次のようになります（よりきれいにフォーマットされたJSONの場合は、プリティボタンをクリックします）。

   

9. StudioのPlayersモジュールをチェックインすることで、プレーヤーが作成されたことを確認できます。

環境変数

使用すると便利な場合がありますInsomniaの環境さまざまなAPIのOAuth認証情報を保存するため、またはアカウントIDやビデオまたはプレーヤーIDなどの他の情報を保存するため。

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

1. クリック環境なしの左上の領域にInsomniaドロップダウンメニューを展開して、環境を管理します。

   

2. の中に環境の管理ダイアログで、をクリックします+横にサインサブ環境ドロップダウンメニューを展開して、環境新しい環境を作成するには：

   

3. をダブルクリックします新しい環境に変更する名前プレーヤー管理API（またはあなたが好きなものは何でも）。
4. 環境JSONの中括弧内に、次のキーと値のペアを追加します。
   • "account_id"： " あなたのアカウントID「」
   • "client_id"： " クライアントID「」
   • "client_secret"： " あなたのクライアントの秘密「」

   終了すると、JSONは次のようになります。

   

   （ここでのクライアントの秘密は、セキュリティ上の理由から曖昧になっています。）

5. クリック完了環境を追加するには
6. クリック環境なしもう一度ドロップダウンを展開して、プレーヤー管理環境を使用する（または新しい環境に付けた名前）：

   

7. 次に、すべてのプレイヤーを取得再度開くように要求します。
8. クリックOAuth 2認証セクションを再度開きます。
9. クライアントID値を削除し、入力を開始しますクライアントID -関連する環境変数を示すドロップダウンメニューが表示されます。ここで選択する必要がありますクライアントID：

   

10. 次に、アカウントIDリクエストURLで、次のURLに置き換えますアカウントID変数。
11. 同じことをして、クライアントシークレットの値client_secret変数。
12. 今クリック送信再度、リクエストが引き続き機能することを確認します。

結論

これで、使用の基本を理解できましたInsomnia BrightcoveAPIにリクエストを送信します。無料でアップグレードすることを選択した場合は注意してくださいInsomniaアカウントをチームアカウントにすると、すべてのリクエストと環境を同期して、他のチームメンバーと共有することもできます。