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は併せて提供する必要があります。
サービス APIの制限事項
B2B PRISM Live Studio API使用時の注意事項について説明します。
- REST API
- 基本的な連携は REST APIを使用します。
- 1s以内の応答時間を推奨し、3sを超える場合は正常な動作を保証しません。
- 認証およびセキュリティ
- すべての通信には SSLを利用した HTTPSを使用します。(TLSv1.2以上推奨)
- OAuth2.0を通じて取得した Access Tokenを使用します。
サービス APIリスト
サービス APIリストを紹介します。
必須構築 API
必須構築 APIリストは次の通りです。
| 分類 | 詳細分類 | 説明 | スペック |
|---|---|---|---|
| AUTH | ログインおよび認証 | ||
| CHANNEL | チャンネルの照会 | ||
| ライブを照会 | チャンネルライブリストを照会 | チャンネルライブリスト照会 API仕様書 | |
| LIVE | ライブ情報を照会 | ライブ情報および状態を照会 | ライブ状態および統計照会 API仕様書 |
| ライブを作成 | 新規ライブを作成 | ライブ作成 API仕様書 | |
| ライブの開始および終了 |
任意構築 API
任意構築 APIリストは次の通りです。
| 分類 | 詳細分類 | 説明 | 依存関係 | スペック |
|---|---|---|---|---|
| LIVE_CHAT_LIST | チャットを照会 | チャット照会 API仕様書 | ||
| LIVE_CHAT_SEND | チャットを送信 | チャットを送信 | チャット送信 API仕様書 | |
| LIVE_CHAT_DELETE | チャットを削除 | LIVE_CHAT_LIST | チャット削除 API仕様書 | |
| USER_BAN | チャットユーザーのブロックおよび解除 | LIVE_CHAT_LIST | ||
| USER_MOD | チャット管理者権限の付与および解除 | LIVE_CHAT_LIST |
参考
B2B PRISM Live Studio APIを使用した具体的なプロセスを確認するには、B2B PRISM Live Studio連携ガイドをご参照ください。
APIの基本形式
APIの基本形式について説明します。
リクエストヘッダ
リクエストヘッダは次の通りです。
| 名前 | タイプ | 説明 |
|---|---|---|
| x-prism-client-id | String | 顧客のサービスにおいて、B2B PRISM Live Studioへの OAuth 2.0認証用に提供される、クライアント IDに変更されない値 |
| x-prism-client-secret | String | 顧客のサービスから B2B PRISM Live Studioに OAuth2.0 認証のために提供するクライアント Secret問題などの理由により、必要に応じて協議の上変更可能 |
| x-prism-access-token | String | OAuth 2.0ログイン時に発行・保存して使用し、ログインのたびに変更。Access Tokenが期限切れになると、ACCESS_TOKEN_EXPIRED(1011)エラーが発生 |
参考
リクエストヘッダの 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の共通エラーコード
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などを照会する際、照会対象のオブジェクトが存在しない場合 |
| 1107 | ACCESS_TOKEN_SCOPE | 400 | Bad Request | Access Tokenの権限(scope)が不十分な場合 |
| 2000 | UNEXPECTED_ERROR | 500 | Internal Server Error | 予期せぬサーバエラーが発生した場合 |