Platform Callback
概要
Kollus OVPを利用状況は及びサービス管理は管理画面(CMS)から行うことが基本的な利用形態となりますが、顧客側の利便性向上のために指定したWeb URL (主に顧客側の管理ページなど)にCMSで行われる作業状況を転送しています。
これを「Callback」といいます。指定したWeb URlへのCallback転送が失敗した場合には再び転送をトライしており、各リトライの度にKollus側のログを記録することでリトライが失敗した際の原因を究明・正常にCallback転送が行われるように仕組まれています。
本文書にはCallback転送とリトライに対したKollus Callback転送サーバーの処理プロセスを説明します。
Callback 設定
Callbackは配信チャンネル編集ページの「運用ポリシー」メニュからチャンネル関連Callbackを設定することができます。
運用ポリシーメニュから設定できないCallback (Upload callback, Transcoding Callback, Contents update callback, Drop-off callback)は担当者までお問い合わせください。
チャンネル Callback 設定 (チャンネルにコンテンツ登録、削除結果の転送)
配信チャンネルに移動します。
チャンネル編集ページに移動します。
運用ポリシーに移動します。
Call-back使用を「利用する」にします。
必要なChannel Callbackを登録します。
その他Callbackの設定 (Upload callback, Transcoding Callback, Contents update callback, Drop-off callback)
Kollus サービス担当窓口までお問い合わせください。
Callback 転送処理
転送方法
- 全てのCallbackはお客様が設定したWeb URLの80番ポートにPOST方式を利用して転送します。
- 全てのCallbackは転送時点になると、即時転送することを原則とします。(Callbackを処理するサーバーの負荷状況により遅延される可能性があります。)
- 顧客側のWebサーバーがCallbackを受け取った場合、200 HTTP Status Codeでレスポンスしなければなりません。レスポンス内容のHTTP body部分は確認しません。(200以外のコードでレスポンスした場合には転送失敗と見なし、指定時間後に転送をリトライします。)
注意事項
顧客側のサーバーはKollusのCallback転送リクエストに対して2秒以内にアクセスし、接続から3秒以内にレスポンスを返さなければなりません。
時間内にアクセスがないまたは応答がなかった場合にはKollus Callback転送サーバーは転送失敗と見なして指定された時間後にリトライします。(Connect Time-out 2秒, Response Time-out 3秒)
Callback転送プロセス
Callback 転送リトライ処理
転送方法
- 基本的な内容は「Callback転送処理」項目と同一です。
- リトライは5分間隔で最大3回まで行われます。
注意事項
顧客側のサーバーがKollus Callbackを正常に処理したと見なして200 HTTP Status CodeをレスポンスしてもそのレスポンスがConnect/Response Time-outが切れてから行われた場合、
Kollus Callback転送サーバー側は既に転送失敗と処理されてCallbackリクエストをリトライすること可能性があります。
つまり、Time-outが原因で同一のCallbackが再びリクエストされる場合がありますのでCallback URLの開発時に考慮しなければなりません。
Callback転送 リトライプロセス
Callback 転送パラメータ
アップロード完了 Callback
POST | Data type | 備考 |
---|---|---|
content_provider_key | string | 顧客のサービスアカウントキー |
full_filename | string | アップロードされたファイル名(フォルダ含む) |
filename | string | アップロードされたファイル名 |
upload_file_key | string | アップロードファイルキー |
トランスコーディング完了 Callback
POST | Data type | 備考 |
---|---|---|
content_provider_key | string | 顧客のサービスアカウントキー |
filename | string | アップロードされたファイル名(フォルダ含む) |
upload_file_key | string | アップロードファイルキー |
transcoding_result | string | トランスコーディング結果 (success, fail) |
チャンネルにコンテンツ登録完了 Callback
POST | Data type | 備考 |
---|---|---|
content_provider_key | string | 顧客のサービスアカウントキー |
full_filename | string | アップロードされたファイル名(フォルダ含む) |
filename | string | アップロードされたファイル名 |
upload_file_key | string | アップロードファイルキー |
media_content_key | string | メディアコンテンツキー (配信チャンネルに登録されたコンテンツを識別するためのユニークキー) |
channel_key | string | チャンネルキー(コンテンツが登録されたチャンネルを識別するキー) |
channel_name | string | コンテンツが登録されたチャンネル名 |
profile_key | string | コンテンツがトランスコーディングされたプロファイル名(複数の場合 ‘|’で区分) |
update_type | string | 更新種類: channel_join (チャンネルにコンテンツ登録) |
チャンネルのコンテンツ削除完了 Callback
POST | Data type | 備考 |
---|---|---|
content_provider_key | string | 顧客のサービスアカウントキー |
full_filename | string | アップロードされたファイル名(フォルダ含む) |
filename | string | アップロードされたファイル名 |
upload_file_key | string | アップロードファイルキー |
media_content_key | string | メディアコンテンツキー (配信チャンネルに登録されたコンテンツを識別するためのユニークキー) |
channel_key | string | チャンネルキー(コンテンツが登録されたチャンネルを識別するキー) |
channel_name | string | コンテンツが登録されたチャンネル名 |
update_type | string | 更新種類: channel_leave (チャンネルからコンテンツ削除) |
コンテンツ更新 Callback
POST | Data type | 備考 |
---|---|---|
content_provider_key | string | 顧客のサービスアカウントキー |
full_filename | string | アップロードされたファイル名(フォルダ含む) |
filename | string | アップロードされたファイル名 |
upload_file_key | string | アップロードファイルキー |
update_type | string | 更新種類: 変更された結果が必要な場合にはAPIを呼び出して該当コンテンツの情報を確認してください。 API: /media/library/media_content/{upload_file_key} |
content_title: タイトル変更 content_tag: タグ変更 content_category: カテゴリ変更 content_enable: コンテンツを有効化 content_disable: コンテンツを無効化 profile_add: エンコーディングプロファイルを追加 profile_delete: エンコーディングプロファイルを削除 origin_delete: 原本ファイルを削除 content_subtitle: 字幕をアップロード content_poster: ポスターをアップロード content_detail: コンテンツ詳細情報URLを変更 content_delete: コンテンツを削除 |
Copyright © CATENOID, lnc. All Rights Reserved.
E-mail. jp_sales@catenoid.net | Tel. 03-4405-8462