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

    概要: ポリシーAPI

    このトピックでは、ポリシー API の用途と使用方法を学習します。ポリシー API は、ポリシーキーを作成または取得するために使用されます。
     

    はじめに

    ザ・ポリシーキーを使用してVideoCloudライブラリからビデオとプレイリストのコンテンツを取得するために使用されます再生API

    API リファレンス」も参照してください。

    必要ですか?

    独自のポリシーキーを生成する必要がある特別な場合のみがあります。

    • Brightcoveプレーヤーのポリシーキーは、作成時に自動的に生成されます。プレーヤーのジオフィルタリングを使用してキーを取得する場合、またはプレーヤーを作成せずにPlayback APIにアクセスする場合にのみ、このAPIを使用してポリシーキーを直接生成する必要があります。通常、これは、デバイスSDK。見るポリシーキー Brightcoveプレーヤーのポリシーキーを取得する方法については、こちらをご覧ください。
    • ビデオ検索リクエストの実行:
      • あなたは使用する必要があります検索対応のポリシーキー
      • 新しいBrightcoveプレーヤー用に生成されたポリシーキーは、デフォルトでは検索が有効になっていません。これは、を使用して手動で設定する必要がありますポリシーAPI
      • 一般に、検索が有効なポリシーキーはサーバーにのみ保存し、ブラウザープレーヤーやモバイルアプリには保存しないでください。これは再生可能な動画をすべて一覧表示するために使用できるためです。一部のアカウントでは、再生可能なすべての動画を検出できることを気にしない場合、これは適用されない場合があります。
      • 検索リクエストは、再生可能な動画のみを返します。API リクエスト/レスポンスの詳細については、「再生 API リファレンス」の「ビデオの取得」セクションを参照してください。

    よくある質問

    一般的に取得するポリシーAPIに関するいくつかの質問があります。

    ポリシーキーは複数のアカウントに対して作成できますか、それとも1つだけ作成できますか?
    ポリシーキーを使用すると、1つのアカウントの動画と再生リストにアクセスできます。複数のアカウントをお持ちの場合は、それぞれにポリシーキーを作成する必要があります。
    ポリシーキーは期限切れになりますか?
    いいえ、ポリシーキーは永久に有効です。ポリシーキーを取り消す必要がある場合は、連絡する必要がありますBrightcove ブのサポート -取り消すアカウントIDとポリシーキーをリクエストに含めます。
    ポリシーキーはアカウントのすべてのユーザーに対して機能しますか?
    はい、ポリシーキーを持っている人なら誰でも使用できます。
    ポリシーキーを更新できますか?
    いいえ、ポリシーキーを更新する方法はありません。あなたはどちらかをすることができますポリシーキーを取得する Video Cloudアカウントの既存のプレーヤーから、またはPolicyAPIを使用して新しいポリシーキーを作成できます。

    ベース URL

    ポリシーAPIのベースURLは次のとおりです。

        https://policy.api.brightcove.com/v1

    アカウントパス

    いずれの場合も、特定の Video Cloud アカウントに対してリクエストが行われます。だから、あなたは常に追加します/accounts/ その後に、ベースURLへのアカウントIDが続きます。

        https://policy.api.brightcove.com/v1/accounts/{account_id}

    認証

    リクエストは、渡されたアクセストークンによって認証されますAuthorization ヘッダ:

        Authorization: Bearer {access_token}

    アクセストークンを取得するには、次の手順に従います。

    1. クライアントの資格情報を取得します(client_id そしてclient_secret ) 使ってVideo Cloud Studio(推奨)。

      ポリシーキーの作成リクエストで使用できるアクセストークンの場合、クライアントの認証情報には、Studioで次の権限が必要です。プレーヤーの読み取りと読み取り/書き込み

      認証権限
      認証権限

      クライアントの資格情報を直接取得することもできます。 Brightcove OAuth API

    2. クライアントの資格情報を取得したら、次のことができますOAuthAPIから一時的なアクセストークンを取得します

    必要なヘッダー

    に加えてAuthorization前のセクションで説明したヘッダーでは、リクエストにはContent-Typeヘッダ:

        Content-Type: application/json

    ポリシーキーを作成する

    新しいポリシーキーを作成するには、次の宛先にPOSTリクエストを送信します。

        https://policy.api.brightcove.com/v1/accounts/{account_id}/policy_keys

    リクエスト本文

    リクエストの本文に、ポリシーのJSONを含めます。

        {
          "key-data": {
            "account-id": "{account_id}"
          }
        }

    これは、アカウントへのアクセスを制限する最も基本的なポリシーです。作成するポリシーにこれを含める必要があります。ここでのアカウントIDは、リクエストURLのアカウントIDと一致する必要があります。一致しない場合、エラーが返されます。

    ドメイン制限

    アカウントへのアクセスを制限することに加えて、を追加することで特定のドメインへのアクセスを制限することもできますallowed-domains キー:

        {
          "key-data": {
            "account-id": "123456789001",
            "allowed-domains": [
              "http://www.abc.com",
              "https://www.abc.com",
              "http://www.xyz.com",
              "https://www.xyz.com"
            ]
          }
        }

    地理的制限

    Policy APIを使用して、プレーヤーの代わりに、またはそれに加えて、プレーヤーの地域フィルタリングを実装できます。個々のビデオ。

    サンプル

    これは、米国と米国の領土および軍事基地からの再生のみを許可するホワイトリストポリシーセットの例です。

        {"account-id": "8523232323",
          "geo": {
            "countries": ["us", "usmil", "pr", "gu", "vi", "as", "mp"],
            "exclude_countries": false
          }
        }

    代わりにそれらの国をブラックリストに登録するには、exclude_countries 本当に。

    SSAIが必要

    サーバー側の広告挿入(SSAI)を使用する場合、APIリクエストで適切な広告構成を適用する方法が必要になる場合があります。これを行うには、ポリシーキーを構成して、ad_config_id すべてのPlaybackAPIリクエストにURLパラメータとして追加されます。

    サンプル

    例を次に示します。

        {
          "key-data": {
            "account-id": "1752604059001",
            "require-ad-config": true
          }
        }

    使用の詳細についてはad_config_id 再生APIリクエストについては、再生APIの概要:SSAIによるビデオリクエスト資料。

    動画を検索する

    ビデオ検索リクエストを実行するときは、検索が有効になっているポリシーキーを使用する必要があります。検索対応のポリシーキーを作成するには、呼び出しのリクエスト本文に次のものが含まれている必要があります。

        {
          "key-data": {
            "account-id": "57838016001",
            "apis": ["search"]
          }
        }

    API レスポンス

    ポリシー作成リクエストへの応答は、暗号化されたものを含むJSONになりますkey-string これを使用して、Playback APIへのリクエストと、キーに関連付けられたポリシーを認証できます。

        {
          "key-data": {
            "account-id": "57838016001"
          },
          "key-string": "BCpkADawqM0NK0Rq8n6sEQyWykemrqeSmIQqqVt3XBrdpl8TYlvqN3hwKphBJRnkPgx6WAbozCW_VgTOBCNf1AQRh8KnmXSXfveQalRc5-pyNlSod5XzP99If2U"
        }

    ポリシーリクエスト

    に関連付けられているポリシーオブジェクトを取得するにはkey-string 、次の宛先にGETリクエストを送信します。

        /accounts/v1/{account_id}/policy_keys/{key_string}

    応答は、キー文字列とポリシーのJSON表現になります。

        {
          "key-data": {
            "account-id": "57838016001"
          },
          "key-string": "BCpkADawqM0NK0Rq8n6sEQyWykemrqeSmIQqqVt3XBrdpl8TYlvqN3hwKphBJRnkPgx6WAbozCW_VgTOBCNf1AQRh8KnmXSXfveQalRc5-pyNlSod5XzP99If2U"
        }

    ポリシーを取り消す

    既存のポリシーを取り消す必要がある場合は、にリクエストを送信してくださいBrightcove ブのサポート。取り消すポリシーのキー文字列をリクエストに含めます。