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

CMS API お知らせ

このトピックでは、 CMS API 通知。 ザ CMS API アカウントユーザーが作成したかどうかに関わらず、アカウントの動画の変更に関する通知を提供します Video Cloud システム。

概要

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

認証

へのすべての要求のように CMS API通知サブスクリプションを設定または一覧表示する要求は、 アクセストークン。 アクセストークンを取得するために使用されるクライアント認証情報には、 video-cloud/notifications/all (CMS->Notifications あなたが使用する場合 スタジオ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 イベントが発生した時刻 Epoch ミリ秒
account_id インクルード Video Cloud アカウントID
event イベントのタイプ - 現在これは常に video-change
video ビデオID
version ビデオのバージョン - 変更イベントの各セットはビデオバージョンをインクリメントします。たとえば、新しいレンディションセットの作成は一連の変更イベントを構成します

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

  • 挽き目 endpoint or events リクエストの本文にフィールドがありません
  • 挽き目 events フィールド値はリストではありません(配列)
  • すでに定義されているサブスクリプション
  • あなたは既にこのイベントへの10購読を持っています

通知の失敗

通知システムは、 4xx or 5xx 再試行可能な障害として顧客サーバからの復帰。 失敗したコールバックは20回まで再試行され、後続のコールバック間では指数関数的に遅延が増加します。 最初の数回の再試行は、最初のコールバック試行の数分以内に行われます。 コールバックが失敗し続けていて、20thの再試行までになった場合、再試行の遅​​延は数日になります。

ファイアウォール

ファイアウォールを通過する着信トラフィックの送信元に関する厳格なポリシーが組織にある場合は、AWS us-east-1 / Virginia IPを許可します。 これは変更される可能性があるため、すべての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 要求をサブスクリプションエンドポイントに送信します。

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

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

エンドポイント

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

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

通知をトリガするのは何ですか?

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

イベントを引き起こす変更には次のものがあります。

  • 動画が作成されました
  • 動画またはアセットファイルの処理開始
  • ビデオまたはアセットファイルの摂取が完了しました
  • 新しい演奏のエンコーディングが終了する
  • ポスター画像が作成されます
  • サムネイル画像が作成される
  • 動画が削除されました
  • ビデオメタデータが(システムまたはユーザによって)変更される

ノート

動画を再トランスコードしてもトリガーされません video-change 結果のレンディションセットが異なる場合を除きます。

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

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


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