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

    API リクエストに郵便配達を使用する

    このトピックでは、Brightcove RESTfulAPIにリクエストを送信するように人気のあるPostmanHTTPクライアントを設定する方法を学習します。ドキュメントのこのセクションのほとんどの例で使用されているcurlステートメントとコマンドラインは、難しくて威圧的であると感じる人もいます。このような場合、ほとんどのBrightcove ブ API を含む REST ベースのサービスに HTTP リクエストを送信するためのツールが多数用意されています。このドキュメントでは、そのようなツールの1つであるPostmanアプリの使用方法を説明します。

    インストールPostman

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

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

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

    • プレイヤー読み書き

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

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

    Postman を使用する

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

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

    1. を起動しますPostmanアプリ。
    2. 新しいリクエストを作成します。
      新しいリクエストの作成
      新しいリクエストの作成
    3. 新しいリクエストダイアログで、リクエスト名に「GetPlayers」と入力します。
      リクエスト名
      リクエスト名
    4. [コレクションの作成]をクリックし、コレクション名として「PlayerManagementAPI」と入力します。
      リクエストコレクションの作成
      リクエストコレクションの作成
    5. コレクションを保存します。
    6. 左側のリストでPlayerManagement APIコレクションを見つけ、それをクリックして新しいリクエストを開きます。
      プレーヤー管理 API コレクション
      プレーヤー管理 API コレクション
    7. に移動します承認タブで、タイプとしてOAuth 2.0を選択し、[リクエストヘッダーに認証データを追加する]が選択されていることを確認します。
      認証セクション
      認証セクション
    8. クリック新しいアクセストークンを取得する
      新しいアクセストークンの取得
      新しいアクセストークンの取得
    9. ダイアログで、次の情報を入力します。
      • トークン名:プレーヤー管理API
      • 付与タイプ:クライアント認証
      • アクセストークンのURLhttps://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
              
              
      リクエストURLを入力してください
      リクエストURLを入力してください
    2. メソッドをそのままにしますGET、をクリックします送信
      リクエストを取得
      GETリクエスト
    3. レスポンスは次のようになります。
      応答を取得
      応答を取得

    POSTリクエストを送信

    今、私たちは送信しますPOSTいくつかのデータを要求します。この場合、Player ManagementAPIを使用して新しいプレーヤーを作成します。

    POSTリクエストする

    1. GetPlayersリクエストを複製します。
      リクエストの複製
      リクエストの複製
    2. 新しいリクエストを開き、名前を「CreatePlayer」に変更します
      名前の変更要求
      名前の変更要求
    3. の場合と同じURLを使用しますGET上記の手順をリクエストしますが、ここで選択しますPOST選択されたHTTPメソッドになります。
      ポストリクエスト
      POSTリクエスト
    4. クリック URLのすぐ下にあるタブをクリックし、ラジオボタンとJSON(アプリケーション/ json)タイプドロップダウンメニューから:
      リクエスト本文
      リクエスト本文
    5. 新しいヘッダーがリクエストに自動的に追加されることに気付くかもしれません。データを送信するリクエストには、送信されているデータの種類をAPIに通知するヘッダーが必要です。クリックヘッダータブを表示してContent-Type: application/jsonヘッダ:
      ヘッダーを追加
      ヘッダーを追加
    6. 生データの場合は、本文に次の JSON コードを入力します (JSON に続くスクリーンショットは、リクエストの表示方法を示しています)。
              {
                    "name": "Postman Test Player"
                    }
              
    7. [ 送信 ] をクリックします。
    8. レスポンスは次のようになります(よりきれいにフォーマットされたJSONの場合は、プリティボタンをクリックします)。

      POSTレスポンス
      POSTレスポンス
    9. Studioの[プレーヤー]セクションをチェックして、プレーヤーが作成されたことを確認できます。

    環境変数

    複数のアカウントおよびAPI操作の任意の組み合わせに対してクライアント資格情報を作成できますが、資格情報の範囲を単一のアカウントとAPI(または特定のAPI操作)に制限することで、セキュリティを強化したい場合があります。もしそうなら、あなたは利用することができますPostman環境変数複数のアカウントと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仕様に基づいているため、この機能を使用して、任意のBrightcoveAPIのリクエストの完全なコレクションを生成できます。

    以下の手順では、Dynamic Ingest API例として、この手順はどのBrightcoveプラットフォームAPIでも機能します(ない PostmanはRESTAPIのみをサポートしているため、PlayerAPIまたはモバイルSDKの場合)。

    ステップ

    1. ブラウザで、動的取り込みAPIリファレンス
    2. クリックしてくださいDownloadタイトルの下にあるボタンをクリックしてダウンロードしますOpenAPI specification APIの場合:
      OpenAPI 仕様をダウンロードする
      OpenAPI 仕様をダウンロードする
    3. 使用しているブラウザによっては、仕様(YAMLファイル)がダウンロードされるか、新しいブラウザタブで開く場合があります。ブラウザで開いた場合は、コンテンツをコピーしてテキストファイルに貼り付けるか、ページソースをローカルドライブに保存します。ファイルには名前を付ける必要がありますopenapi.yaml
    4. 今すぐに行きますPostmanをクリックしますImport左側のウィンドウ上部にあるボタン:
      郵便配達員のインポートボタン
      郵便配達員のインポートボタン
    5. ドラッグアンドドロップopenapi.yamlファイルマネージャから開いたインポートモーダルへのファイル:
      郵便配達のインポートモーダル
      郵便配達のインポートモーダル
    6. Postmanファイルを処理すると、リストに新しいコレクションが表示されます。Dynamic Ingest API Reference
      新しい郵便配達コレクション
      新しい郵便配達コレクション
    7. を介してフォルダにドリルダウンaccounts/{account id}/video/{video id}リクエストが表示されます:
      リクエストへのドリルダウン
      リクエストへのドリルダウン
    8. を選択POSTそれを開くように要求します。あなたは両方を見つけるでしょうParamsそしてそのBody APIリファレンスから事前に入力されていますが、データ型を示すプレースホルダーを実際のデータに置き換える必要があります。
      事前設定されたパラメータ
      事前設定されたパラメータ
      事前移入されたボディ
      事前移入されたボディ
    9. プレースホルダーを適切な値に置き換えたら、自分で作成したものと同じようにリクエストを使用できます。