CMS API通知

このトピックでは、 CMS API通知。NS CMS APIアカウントユーザーまたはVideoCloudシステムのどちらによって行われたかに関係なく、アカウント内のビデオへの変更の通知を提供します。

概要

通知を受け取ることができるのはvideo-changeイベントはビデオライブラリで発生します。指定したURLに通知が送信されます。このURLは、処理可能なアプリケーションを指している必要があります。 HTTP POSTリクエスト。

認証

CMS APIへのすべてのリクエストと同様に、通知サブスクリプションを設定または一覧表示するリクエストは、アクセストークン。アクセストークンの取得に使用されるクライアントの資格情報には、次の権限が必要です。video-cloud/notifications/all（（ CMS->通知あなたが使用する場合スタジオUIクレデンシャルを作成します。）

セットアップ

通知を受信するエンドポイントを最大10個指定できます。POSTリクエストするhttps://cms.api.brightcove.com/v1/accounts/{account_id}/subscriptions次のようにリクエスト本文にJSONを含めます。

        {
        "endpoint":"http://solutions.brightcove.com/bcls/di-api/di-callbacks.php",
        "events":["video-change"]
        }

通知はJSON形式で送信されます。下記がその例です。

        {"timestamp":1423840514446,
        "account_id":"775205503001",
        "event":"video-change",
        "video":"4020894387001",
        "version":26}

通知フィールド

項目	説明
`timestamp`	イベントが発生した時間時代ミリ秒
`account_id`	NS ビデオクラウドアカウントID
`event`	イベントの種類-現在、これは常に`video-change`
`video`	ビデオID
`version`	ビデオのバージョン（変更イベントの各セットはビデオバージョンをインクリメントします）。たとえば、新しいレンディションのセットを作成すると、変更イベントのセットが構成されます。

サブスクリプションを作成するリクエストは、 HTTP 422次の条件のエラー応答：

ザ・endpointまたはeventsリクエスト本文にフィールドがありません
ザ・eventsフィールド値がリスト（配列）ではありません
定義されたサブスクリプションはすでに存在します
このイベントにはすでに10のサブスクリプションがあります

通知の失敗

通知システムは4xxまたは5xx再試行可能な障害としてカスタマーサーバーから返されます。失敗したコールバックは 20 回まで再試行され、後続のコールバック間の遅延は急激に増加します。最初の数回の再試行は、最初のコールバック試行から数分以内に行われます。コールバックが失敗し続け、20 回目の再試行まで続く場合、再試行遅延は数日になります。

ファイアウォール

組織がファイアウォールを通過する着信トラフィックのソースに関して厳格なポリシーを持っている場合、AWS us-east-1 / VirginiaIPを許可します。これは変更される可能性があるため、すべての AWS IP をホワイトリストに登録する必要があります。見るhttp://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html詳細については。

通知サブスクリプションのエンドポイント

        /accounts/{account_id}/subscriptions

新しいサブスクリプションを作成する

新しいサブスクリプションを作成するには、POST通知を配信するエンドポイントを含むリクエスト本文を含むリクエストとvideo-changeの単一アイテムとしてeventsアレイ：

        { "endpoint": "http://solutions.brightcove.com:9002", "events": [ "video-change" ] }

サブスクリプションのリストを取得する

すべてのサブスクリプションのリストを取得するには、GETサブスクリプションエンドポイントへのリクエスト。

単一のサブスクリプションを取得または削除する

次のエンドポイントを使用して、単一のサブスクリプションを取得または削除します。

終点

        /accounts/{account_id}/subscriptions/{subscription_id}

A GETリクエストはサブスクリプションを取得します。A DELETEリクエストはサブスクリプションを削除します。現在、サブスクリプションを更新することはできません。サブスクリプションを変更する場合は、サブスクリプションを削除して新しいサブスクリプションを作成する必要があります。

通知をトリガーするものは何ですか？

video-changeイベントは、ビデオメタデータの変更によってトリガーされます。これには、StudioまたはCMS API書き込みメソッド。トリガーするシステムイベントもありますvideo-changeイベント。

イベントをトリガーする変更は次のとおりです。

ビデオが作成されます
ビデオまたはアセットファイルの取り込みが開始されます
ビデオまたはアセットファイルの取り込みが完了しました
新しいレンディションのエンコードが終了します
ポスター画像を作成します
サムネイル画像を作成します
ビデオが削除されます
ビデオメタデータは（システムまたはユーザーによって）変更されます

注

ビデオを再トランスコーディングしても、video-change結果のレンディションセットが異なる場合を除き、イベント。

動画が削除された後に発生するシステムイベントがあるため、動画を削除すると通知が届きます。

何がないトリガーvideo-changeイベントは、ビデオメタデータを変更しないビデオアセットへの変更です。たとえば、リモートテキストトラックファイルまたは画像を置き換えても、ビデオメタデータに記録されたURLは同じままである場合、video-changeイベントが発生し、通知は送信されません。