RTC認証およびキーAPI
3つの異なる認証情報認証情報誰が使用するのか
Section titled “3つの異なる認証情報認証情報誰が使用するのか”| 認証情報 | 誰が使用するか | 適切な場所 |
|---|---|---|
| CHAMPREP サインインセッション | RTCコンソールを管理する担当者 | 一元化されたサインインおよびコンソールのフロー |
| RTCプロジェクトのキーAPI | アプリケーションのバックエンド | サーバーサイドでのシークレットの保存のみ |
| 参加者の認証情報 | 1つのクライアントが承認済みのルームに参加する場合 | そのクライアントのアクティブな参加フロー |
統合において、プロジェクトキーの代わりにプライマリアカウントのセッションを使用することは 絶対に避けてください。また、プロジェクトキーをブラウザのJavaScript、モバイルバンドル、 ソースリポジトリ、分析ツール、ログ、または公開URLに送信することも絶対に避けてください。
- RTCコンソールで、まだ作成していない場合はプロジェクトを作成してください。
- 開く API キー を選択し、 キーの作成.
- 名前を入力し、プロジェクトを選択し、必要最低限の権限を選択してください。
- 選択 作成 そして、 新しい認証情報 ダイアログ。
- キーは、アプリケーションのサーバーサイドのシークレットマネージャーに保存してください。
シークレットの全文は作成時にのみ表示されます。現在のコンソールでは、 有効期限が90日のキーが生成されます。有効期限の編集機能は提供されていません。シークレットを 紛失した場合や有効期限が切れた場合は、新しいキーを作成してください。キーの一覧から復元することはできません。
権限スコープ
Section titled “権限スコープ”| スコープ | 許可される操作 |
|---|---|
rooms:read | キーが属するプロジェクト内のルームを一覧表示する |
rooms:write | そのプロジェクト内でルームを作成および終了する |
tokens:write | オープンルームの参加者認証情報を発行する |
recordings:read | プロジェクトの録画一覧の取得およびトラックのダウンロードリクエスト |
recordings:write | プロジェクトの記録ジョブの開始と停止 |
webhooks:read | プロジェクトの Webhook エンドポイントと配信ログを一覧表示します |
webhooks:write | プロジェクトの Webhook エンドポイントの作成、変更、テスト、および再生 |
通常、呼び出しを生成するバックエンドには以下が必要です。 rooms:write, tokens:write、 および rooms:read。記録権限は、必要な場合にのみ付与してください。プロジェクトキーでは、 組織の作成、プロジェクトの作成、キーや署名キーの管理、 およびプラットフォームの管理を行うことはできません。これらの顧客設定タスクについては、コンソールをご利用ください。Webhookスコープでは、 1つのキーが管理できるのは、自身のプロジェクトのエンドポイントのみとなります。
キーは、1つのプロジェクトにのみ属します。変更する projectId リクエストにキーが含まれていても、 他のプロジェクトにアクセスできるわけではありません。アクセスおよび機能の割り当て制限は引き続き 適用されます。有効なキーを所有しているからといって、サブスクリプションの制限を回避できるわけではありません。
サーバーを呼び出す API
Section titled “サーバーを呼び出す API”RTCの本番環境向け顧客APIの基盤APIは https://api.rtc.champrep.com. これは一般的な とは別のものであり、CHAMPREPAPI GatewayRTCキーを使用します。
# Set RTC_API_KEY securely in your server environment before running this.curl --fail-with-body \ --header "Authorization: Bearer $RTC_API_KEY" \ https://api.rtc.champrep.com/v1/roomsHTTPS および JSON ボディを使用してください。クエリ文字列にキーを含めないでください。ブラウザは を呼び出す必要があります バックエンド。これにより RTC が呼び出されます。サーバーキーを使用して 管理エンドポイントを直接呼び出してはなりません。
自身のユーザーを承認する
Section titled “自身のユーザーを承認する”参加者の認証情報を発行する前に、バックエンドでユーザーの セッションおよび特定のルームに参加する権限を確認する必要があります。アプリケーションのルームを サーバー上の RTC ルームにマッピングしてください。たとえキーがそれらにアクセスできる場合でも、クライアントから送信された任意のルーム ID やプロジェクト ID を 信頼しないでください。
この トークンエンドポイント 一時的な認証情報セットを 返します。参加者ごとに、また再接続のたびに、 新しいセットを発行してください。 canPublish: false これにより、参加者は受信専用となります。トークンは アプリケーションのメンバーシップチェックに代わるものではありません。参加ごとにAPIAPI呼び出しを行わずに 参加者のアクセス権を付与するには、 結合トークン 署名済み プロジェクト署名キーで署名されています。
ローテーションと取り消し
Section titled “ローテーションと取り消し”必要なスコープを含む新しいキーを作成し、サーバーのシークレットストレージを更新し、 統合を確認してから、 キーの取り消し 古いキーについては、秘密情報が漏洩した場合は直ちに 失効させてください。失効処理を行うと、その後のリクエストがブロックされ、 そのキーによって発行されたダウンロード許可が無効になります。ただし、これにより すでに参加している参加者の接続が切断されるとは限りません。影響を受けるルームを終了させて、そのセッションを終了させてください。
サポートに認証情報を送信することは絶対に避けてください。代わりに、操作内容、タイムスタンプ、HTTPステータス、 および伏せ字処理されたエラー情報を共有してください。