B2B PRISM Live Studio 連携の概要

Classic/VPC環境で利用できます。

B2B PRISM Live Studioを利用するには、クライアントサービスにこのガイドで提供する仕様に従って必要な API(サービス API)を構築する必要があります。

サービス APIの構築が必要な理由

サービス APIは、B2B PRISM Live Studioでクライアントサービスにライブを配信するために必要な情報をやり取りするゲートウェイとして機能します。したがって、クライアントサービスで必ず仕様に合わせて APIを構築して安定的に運用することで、正常な連携が可能となります。

新規ライブの作成とライブ情報の照会

B2B PRISM Live Studioは、クライアントサービスに新規ライブを作成し、ライブの情報を照会して配信を開始できる必要があります。クライアントサービスは、PRISM Live Studioでライブを配信するために必要な配信パス(例) RTMP URL)などの情報をサービス APIを通じて転送する必要があります。

ライブ状態の確認

B2B PRISM Live Studioは、ライブの現在の状態を定期的に確認します。クライアントサービスで特定のライブ配信を強制終了またはブロックする場合、B2B PRISM Live Studioでもライブの状態をストリーマーに通知し、ライブを終了します。

ライブメトリック収集

B2B PRISM Live Studioを通じて現在進行中のライブの視聴者数、いいね数、チャット数などのメトリック情報を収集し、ストリーマーに転送できます。

その他の機能連携

クライアントサービスは、ライブに必要な付加機能を APIの形式で PRISM Live Studioに提供し、ストリーマーに配信の利便性を提供できます。提供される付加機能は、次の通りです。

チャット送信と照会
チャットユーザーのブロックと解除
チャット管理者の登録と解除

サービス APIの使用方法

B2B PRISM Live Studioのサービス APIは、基本規格とセキュリティガイドに従って構築する必要があります。

REST APIを使用する

REST APIを使用する際は、以下の点にご注意ください。

サービス APIは REST APIの規格に従います。
GET/POST/PUT/DELETE methodsを使用します。
- OPTIONS/HEAD methodはセキュリティ上の問題があるため、絶対に外部に提供してはいけません。
リクエストするチャンネルやライブ情報がない場合、HTTP statusとして200 OKや Empty Bodyではなく、必ず 404 Not Found を提供する必要があります。
チャンネルなどのリソースリストをリクエストする場合、必ず変更時間の逆順 → 作成時間の逆順で提供する必要があります。

セキュリティと認証

すべてのサービス APIは、セキュリティのために TLSv1.2以上の SSL接続で提供する必要があります。サービス APIの権限は、OAuth2.0認証で提供する必要があります。

B2B PRISM Live Studioは、クライアントサービスで提供する OAuth2.0認証を使用してサービス APIのアクセス権限を持つ Access Tokenを取得し、これを利用してサービス APIを呼び出します。
クライアントサービスと OAuth2.0認証で連携するには、クライアントサービスを登録する際に、必ず以下の情報を入力してください。
- client-id: OAuth2.0サーバがクライアントアプリケーションを識別するために使用される公開された文字列です。
- client-secret: OAuth2.0サーバがクライアント IDと一緒にクライアントの身元を確認するために使用するパスワードです。
B2B PRISM Live Studioは OAuth2.0認証により以下の情報を取得します。
- Access Token: クライアントがユーザーに代わってリソースサーバとのインタラクションのために使用する文字列です。
- Refresh Token: Refresh Tokenは Access Tokenの有効期限が切れた後、新しい Access Tokenを取得するために使用します。

参考

OAuth2.0連携についての詳細は、OAuth2.0の基本概念と連携をご参照ください。

必須構築 APIと任意構築 API

クライアントサービスで構築すべきサービス APIには、B2B PRISM Live Studioの機能を使用するために必須で構築すべき 必須構築 API と、追加機能を使用するための 任意構築 API があります。

参考

B2B PRISM Live Studioサービス API構築についての詳細は、APIガイドをご参照ください。

必須構築 API

必須構築 API明細は、以下の内容をご確認ください。

分類	詳細分類	説明	スペック
AUTH	ログインと認証	OAuth2.0 Access Tokenの取得および更新ユーザー情報を照会	OAuth2.0認証 API明細ユーザー情報照会 API明細
CHANNEL	チャンネル照会	チャンネルリストを照会チャンネル情報を照会	チャンネルリスト照会 API明細チャンネル情報照会 API明細
	ライブ照会	チャンネルライブリストを照会	チャンネルライブリスト照会 API明細
LIVE	ライブ情報照会	ライブ状態と統計を照会	ライブ状態と統計照会 API明細
	ライブ作成	新規ライブを作成	ライブ作成 API明細
	ライブ開始と終了	ライブ配信を開始ライブ配信を終了	ライブ開始 API明細ライブ配信終了 API明細

任意構築 API

任意構築 API明細は、以下の内容をご確認ください。

分類	詳細分類	説明	Dependency	Spec
LIVE_CHAT_LIST	チャット照会	配信中3~5sに1回ずつ照会 Continuous keyを通じて特定の時点以降のチャット履歴のみ提供する必要がある最大照会可能回数機能を提供する必要がある	-	チャット照会 API明細
LIVE_CHAT_SEND	チャット送信	特定のチャットを送信	LIVE_CHAT_LIST	チャット送信 API明細
LIVE_CHAT_DELETE	チャット削除	特定のチャットを削除チャット削除機能があるサービスでのみ提供チャットに固有 IDが必要	LIVE_CHAT_LIST	チャット削除 API明細
USER_BAN	チャットユーザーのブロックと解除	チャット作成ユーザーの固有 IDが必要現在ブロック状態かどうかを照会できる必要がある	LIVE_CHAT_LIST	チャットユーザーブロック API明細チャットユーザーブロック解除 API
USER_BAN_TEMPORARY	チャットユーザーの一定時間ブロック	チャット作成ユーザーの固有 IDが必要現在ブロック状態かどうかを照会できる必要がある	LIVE_CHAT_LIST USER_BAN	チャットユーザー一時ブロック API明細
USER_MOD	チャット管理者権限の付与と解除	チャット作成ユーザーの固有 IDが必要現在管理者照会が可能である必要がある	LIVE_CHAT_LIST	チャット管理者権限の付与 API明細チャット管理者権限の解除 API明細