B2B PRISM Live Studio 連携の概要

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

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

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

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

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

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

ライブ状態の確認

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

ライブメトリック収集

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

その他の機能連携

お客様のサービスは、ライブに必要な付加機能を APIの形で B2B 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 サーバが client-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があります。

必須構築 API

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

任意構築 API

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