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

概要

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

インストール Insomnia

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

Insomnia BrightcoveのRESTful APIのいずれかにリクエストを送信するために使用できます。 ほとんどの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

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

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

• Players の作成と管理: 読み書き

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

使い方 Insomnia

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

セットアップ Insomnia ワークスペース

他のAPIを使用している場合は、Brightcoveリクエスト専用のワークスペースを作成することができます。

1. 起動する Insomnia アプリ。
2. ドロップダウンをクリックしてください Insomnia をクリックして 新しいワークスペース:

   

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

   

4. ストリーミングを停止する場合は上部の プラス記号 をクリックして 新規フォルダ:

   

5. あなたのフォルダに名前を付ける Player Management API

送信 GET 要求

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

作る GET 要求

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

   

2. リクエストに名前を付ける すべて取得 Players、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 Management API.

これを行うために、我々は すべて取得 Players 要求し、修正する必要があります。 もう一つの素晴らしい機能 Insomnia 要求を複製すると、すべての認証情報が複製されるため、アクセストークンを再度取得するように設定する必要はありません。

作る POST 要求

1. クリックします。 Player Management API フォルダを表示する すべて取得 Players その中のリクエスト。
2. のドロップダウンメニューを展開します。 すべて取得 Players リクエストして選択する 重複ファイル:

   

3. 名前をダブルクリックする すべて取得 Players（コピー） とに変更 作ります Player
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. あなたはそれを確認することができます player チェックインして作成されました Playerスタジオのモジュール。

環境変数

使用すると便利です Insomnia's 環境 さまざまなAPIのOAuth認証情報を保存したり、アカウントIDや動画などの他の情報を保存したり、 player ID。

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

1. ナビゲーションヘッダーの 環境なし 左上の Insomnia ドロップダウンメニューを展開して 環境を管理する。

   

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

   

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

   完成したら、JSONは次のようになります：

   

   （セキュリティ上の理由からここのクライアントの秘密はぼやけています。）

5. ナビゲーションヘッダーの クリックします 環境を追加する
6. ナビゲーションヘッダーの 環境なし もう一度ドロップダウンを展開し、 Linuxを使う Player 経営環境 （またはあなたが新しい環境に与えた名前）：

   

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

   

10. 今すぐ アカウントID リクエストURLに追加し、 アカウントID 変数。
11. 同じことをやり直す クライアントシークレット 値は client_secret 変数。
12. 今すぐクリック 送信 要求がまだ機能していることを確認します。

結論

あなたは今、使用の基本を知っています Insomnia Brightcove APIにリクエストを送信します。 無料のアップグレードを選択した場合は、 Insomnia アカウントをチームアカウントに割り当てると、すべてのリクエストと環境を同期させ、他のチームメンバーと共有することもできます。