B2B PRISM Live Studio の概要

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

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

B2B PRISM Live Studioでお客様のサービスを連携してライブストリーミングを配信するために必要な APIについて説明します。

サービス APIの定義

サービス APIは、B2B PRISM Live Studioでお客様のサービスを連携してライブを配信するために、サービスで必ず提供する必要のある APIです。サービス APIには、必須構築 APIと任意構築 APIがあります。各 APIに関する説明は、次の通りです。

必須構築 API
- B2B PRISM Live Studio機能を使用するために必ず構築する必要のある APIです。
- サポートしていない場合は、サービスを有効にすることができません。
任意構築 API
- B2B PRISM Live Studioの追加機能を使用するために構築する必要のある APIです。
- 種類別に提供することができ、提供有無はサービス設定時に設定できます。
- APIごとに依存関係を持つ他の APIがあり、依存関係がある APIは一緒に提供する必要があります。

B2B PRISM Live Studio APIを使用する際に注意すべき制限事項について説明します。

REST API
- 基本的な連携は REST APIを使用します。
- 1s以内のレスポンス時間を推奨し、3sを超える場合は正常動作を保証しません。
認証およびセキュリティ
- すべての通信は SSLを利用した HTTPSを使用する必要があります。(TLSv1.2以上を推奨)
- OAuth2.0で取得した Access Tokenを使用します。

サービス APIリストを紹介します。

必須構築 APIリストは、次の通りです。

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

任意構築 APIリストは、次の通りです。

分類	詳細カテゴリ	説明	依存関係	スペック
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_MOD	チャット管理者権限の付与と解除	チャット作成ユーザーに対する固有の IDが必要現在管理者の照会が可能である必要がある	LIVE_CHAT_LIST	チャット管理者権限付与 API明細チャット管理者権限解除 API明細

参考

B2B PRISM Live Studio APIを使用する具体的なプロセスを確認するには、B2B PRISM Live Studio連携ガイドをご参照ください。

APIの基本形式について説明します。

リクエストヘッダは次の通りです。

名前	タイプ	説明
x-prism-client-id	String	顧客のサービスで B2B PRISM Live Studioに OAuth2.0認証のために提供するクライアント IDで、変更されない値
x-prism-client-secret	String	顧客のサービスで B2B PRISM Live Studioに OAuth2.0認証のために提供するクライアント Secretで、セキュリティ問題などの理由で必要な場合に協議を通じて変更可能
x-prism-access-token	String	OAuth2.0ログイン時に発行して保存し、ログインごとに変更。Access Tokenが期限切れになった場合、ACCESS_TOKEN_EXPIRED(1002)エラーが発生

参考

リクエストヘッダで Content-typeは次の通りです。
Content-type: application/json

基本レスポンス形式は次の通りです。

名前	タイプ	説明	必須有無
success	Boolean	リクエストの成否	Y
errorCode	Number	成功の場合は0、失敗の場合は API error codeを参照	Y
errorName	String	成功の場合は空白、失敗の場合は API error codeを参照	Y
message	String	詳細なエラーメッセージを提供する場合、より迅速なエラーモニタリングが可能	N
data	Object	成否だけを返す場合は dataがなくても可能であり、各 data形式は API明細を参照	N

API共通エラーコードは、次の通りです。

コード	コード名	HTTP状態コード	HTTP状態コードメッセージ	説明
1000	INVALID_PARAMETER	400	Bad Request	リクエストした path parameterもしくは request bodyに適切でない値がある場合
1001	UNAUTHORIZED_ACCOUNT_ID	401	Unauthorized	無効な account idもしくは account tokenで呼び出す場合
1011	ACCESS_TOKEN_EXPIRED	400	Bad Request	Access Tokenが期限切れになった場合
1012	ACCESS_TOKEN_INVALID	400	Bad Request	Access Tokenが無効な場合
1102	CHANNEL_DISABLED	400	Bad Request	チャンネルが無効になっている場合
1104	RESOURCE_NOT_FOUND	404	Not Found	liveId、channelId、userIdなどを照会する際、照会したいオブジェクトが存在しない場合
2000	UNEXPECTED_ERROR	500	Internal Server Error	予期せぬサーバエラーが発生した場合

この記事は役に立ちましたか?