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

    APIリクエストに不眠症を使用する

    このトピックでは、人気のあるInsomniaHTTPクライアントをセットアップしてBrightcoveRESTfulAPIにリクエストを送信する方法を学習します。

    入門

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

    インストール不眠症

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

    認証

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

    Set Header in Insomnia
    ヘッダーを設定する不眠症

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

    Playback API
      BCOV-Policy: YOUR_POLICY_KEY
    ライブAPI
      X-API-KEY: YOUR_API_KEY
    Zencoder API
      Zencoder-Api-Key: YOUR_API_KEY

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

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

    • ビデオ読み書き

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

    使用する不眠症

    クライアントのクレデンシャルを取得したら、使用を開始する準備ができています不眠症不眠症 CMS APIのOpenAPI仕様をインポートすると、多くのセットアップ作業が行われます。これは、私たちが利用できるようにします。以下の手順では、いくつかの作成について説明します。 CMS APIを使用したリクエスト不眠症

    の設定不眠症 CMS APIのコレクション

    CMS APIのOpenAPI仕様を取得します

    1. を開きますCMS APIリファレンス
    2. クリックダウンロードボタンをクリックして保存しますopenapi.yamlあなたがそれを再び見つけることができる場所にファイルします:
      Download Open API Specification
      OpenAPI仕様をダウンロードする

    OpenAPI仕様をInsomniaにインポートします

    1. を起動します不眠症アプリ。
    2. 横にあるドロップダウンをクリックします不眠症選択しますインポート・エクスポート
      Import/Export
      インポート・エクスポート
    3. 開いたダイアログで、をクリックしますデータのインポート選択しますファイルから
      Import Data from File
      ファイルからデータをインポートする
    4. を選択openapi.yamlダウンロードしたファイルを選択してから、データを現在のワークスペースにインポートするか、新しいワークスペースを作成するかを選択します。どちらでも機能しますが、APIごとに新しいワークスペースを作成することをお勧めします。
      Create New Workspace
      新しいワークスペースを作成する
    5. 次に、データをリクエストコレクションとしてインポートするかデザインドキュメントとしてインポートするかを尋ねられます。選ぶコレクションのリクエスト
      Import as Request Collection
      リクエストコレクションとしてインポート
    6. データがインポートされたことを確認するダイアログが表示されます。
    7. クリックダッシュボードワークスペースを表示するには、左上隅にあります。新しいワークスペースを作成した場合は、適切な名前で表示されます。
      CMS API Workspace
      CMS APIワークスペース
    8. ワークスペースをクリックして開きます。
    9. CMS APIに対するさまざまなリクエストのグループと、新しいOpenAPI環境を含むフォルダーのリストが表示されます。
      CMS API Requests and Environment
      CMS APIリクエストと環境

    環境に変数を追加する

    これはオプションの手順ですが、後でリクエストの認証を簡単に設定できます。

    1. クリックしてくださいOpenAPI環境ドロップダウンメニューを選択し、環境の管理
      Manage Environments
      環境の管理
    2. 次のような環境変数が表示されます不眠症 JSONの形式でOpenAPI仕様から作成されました:
      Environment Variables
      環境変数
    3. これらの追加の変数をJSONに追加します(を参照)クライアントの資格情報を取得する上記のクライアントIDclient_secret):
      • "アカウントID": " your_account_id「」
      • "クライアントID": " your_client_id「」
      • "client_secret": " your_client_secret「」
      • "access_token_url": "https://oauth.brightcove.com/v4/access_token"
    4. 終了すると、環境JSONは次のようになります。
      Environment Variables Added
      追加された環境変数
    5. クリック終わりダイアログを終了するには、右下隅にあります。

    認証を設定する

    これで、APIリクエストの認証を設定する準備が整いました。

    1. クリックビデオフォルダを選択し、ビデオを入手
      New Request
      新しいリクエスト
    2. リクエストのURLにはすでに2つの変数が含まれていることに注意してください。これらをクリックすると、それらの値を表示(および変更)できます。 base_urlによって自動的に生成されます不眠症 OpenAPI仕様から。クリックするとアカウントID、値が前のセクションで環境変数として入力したものと一致することがわかります。
    3. クリック認証タブと認証ドロップダウンメニューをクリックし、 OAuth 2.0
      Select Auth Type
      認証タイプを選択します
    4. クリック付与タイプドロップダウンして選択しますクライアントの資格情報
      Select Grant Type
      付与タイプを選択
    5. の中にアクセストークンのURLフィールドに「access_token_url」と入力し始めます-オートコンプリートメニューが表示され、 access_token_url環境変数:
      Autocomplete for Variables
      変数のオートコンプリート
    6. 前の手順を繰り返して、クライアントIDクライアントシークレットあなたのフィールドクライアントIDclient_secret変数:
      Auth Variables
      認証変数
    7. 下にスクロールして、トークンを取得するボタンをクリックしてクリックします。[アクセストークン]フィールドにトークンが入力されていることを確認してください。
      Access Token
      アクセストークン
    8. クリックトークンを取得するこれが機能することを確認します。次のような応答が表示されます。
      Access Token
      アクセストークン
    9. に移動しますヘッダタブをクリックして削除します承認ヘッダー(設定した認証でヘッドが処理されます-これでヘッドが壊れます):
      Remove Authorization Header
      承認ヘッダーを削除する

    リクエストする

    今、私たちは作る準備ができていますビデオを入手リクエスト。

    1. これは得るリクエスト、あなたがしなければならないのはクリックするだけです送信
    2. JSON応答が応答領域に表示されるはずです。
      API Response
      API レスポンス
    3. を使用してさまざまな動画セットを取得できることに注意してくださいクエリ params。クリッククエリリクエストのタブをクリックすると、不眠症 OpenAPI仕様に基づいてデータを入力しました。使用するパラメータを確認して、値を設定するだけです。
      Query Params
      クエリパラメータ

    送るPOSTリクエスト

    今、私たちは送信しますPOSTいくつかのデータを要求します。この場合、CMS APIを使用して新しいビデオオブジェクトを作成します。を選択することから始めますビデオを作ろうでリクエストビデオフォルダ。

    1. のすべての手順を繰り返します認証を設定するこの新しいリクエストの認証を設定するには、上記のセクションをご覧ください。
    2. このリクエストにはリクエスト本文が必要なので、[JSON]タブをクリックし、このJSONコードを入力してヌル
      {
      	"name": "Insomnia Test"
      }
      Request Body
      リクエスト本文
    3. クリック送信応答で返された新しいビデオオブジェクトが表示されます。

    コードジェネレーターの使用

    のもう一つの素晴らしい機能不眠症それは多くの異なる言語でリクエストを行うためのコードを生成するということです。

    1. リクエストのドロップダウンメニューにカーソルを合わせます。
      Request Dropdown Menu
      ドロップダウンメニューのリクエスト
    2. 選択するコードを生成するメニューから:
      Select Generate Code
      [コードの生成]を選択します
    3. の中にクライアントコードを生成する開いたダイアログで、コードを作成する言語を選択します。
      Select the Language
      言語を選択してください
    4. 多くの言語では、作成しているアプリの種類により適している可能性のある、選択可能なバリアントもあります。
      Select Code Variant
      コードバリアントを選択
    5. コードをクリップボードにコピーするための便利なボタンもあります。
      View and Copy Code
      コードの表示とコピー

    結論

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


    ページの最終更新日22 Sep 2021