サポート サポート問い合わせ先 | システムステータス システムステータス

概要: Policy API

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

概要

挽き目 ポリシーキー あなたのビデオやプレイリストのコンテンツを取得するために使用されます Video Cloud ライブラリを使用して Playback API.

また、 APIリファレンス.

あなたは1つ必要ですか?

独自のポリシーキーを生成する必要がある特殊なケースのみがあります。

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

よくある質問

ここでは、 Policy API 私たちは一般に入手します。

ポリシーキーは、複数のアカウント、または1つだけ作成できますか?
ポリシーキーを使用すると、1つのアカウントのビデオとプレイリストにアクセスできます。 複数のアカウントを持っている場合は、それぞれにポリシーキーを作成する必要があります。
ポリシーキーの有効期限はありますか?
いいえ、ポリシーキーは永遠に良いです。 ポリシーキーを取り消す必要がある場合は、 Brightcoveのサポート - 要求で取り消したいアカウントIDとポリシーキーを含めます。
ポリシーキーはアカウントのすべてのユーザーに適用されますか?
はい。ポリシーキーを持っている人は誰でも使用できます。
ポリシーキーを更新できますか?
いいえ、ポリシーキーを更新する方法はありません。 あなたはどちらか ポリシーキーを取得する 既存から player 自分で Video Cloud アカウント、またはを使用して新しいポリシーキーを作成できます Policy API.

ベースURL

そのベースURL Policy API 次のとおりです。

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

アカウントパス

すべての場合において、要求は特定の Video Cloud アカウント。 したがって、あなたは常に /accounts/ アカウントIDをベースURLに続けて入力します。

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

認証

要求は、アクセスポイントに渡されたアクセストークンによって認証されます。 Authorization ヘッダ:

    Authorization: Bearer {access_token}

トークンにアクセスするには、次の手順を実行します。

  1. クライアントの資格情報を取得する( client_id client_secret )を通じ Video Cloud Studio (推奨)。

    ポリシーキーの作成要求で使用できるアクセストークンの場合、クライアントの資格情報にはStudioで次の権限が必要です。 Players読み取りおよび読み取り/書き込み

    認証のアクセス許可
    認証のアクセス許可

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

  2. クライアント資格情報を取得すると、次のことができます 一時アクセストークンを OAuth API.

必要なヘッダー

に加え 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 のジオフィルタリングを実装するために使用できます player の代わりに、またはそれに加えて 個々の動画

サンプル

米国と米国の領土と軍事基地からの再生のみを許可するホワイトリストポリシーセットの例を次に示します。

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

これらの国をブラックリストに追加するには、 exclude_countries 真実に。

SSAIが必要

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

サンプル

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

使用方法の詳細については、 ad_config_id あなたと Playback API リクエスト、 Playback API 概要:SSAIによる動画リクエスト の資料をご参照ください。

動画の検索

ビデオ検索要求を行うときは、検索可能なポリシーキーを使用する必要があります。 検索可能なポリシーキーを作成するには、コールのリクエスト本文に次のものを含める必要があります。

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

APIレスポンス

ポリシー作成要求に対する応答は、暗号化された key-string あなたがあなたの Playback API、キーに関連付けられたポリシーだけでなく、

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

ポリシーリクエスト

aと関連付けられたポリシーオブジェクトを取得するには key-string 、GETリクエストをして:

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

レスポンスは、キーストリングとポリシーのJSON表現です。

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

ポリシーを取り消す

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


ページの最終更新日:12年2020月XNUMX日