実査機能 設計リファレンス
OpenTok → LiveKit 移行における実査機能の通信契約を、REST API と Webhook の表裏で記述する統合リファレンス。
実査機能とは
実査機能は、パネリストとモデレーターをオンラインで繋ぐ Web インタビュー(実査)の中核機能です。クライアント/フロントエンドからの操作は REST API で、メディア基盤(LiveKit)で起きたイベントは Webhook で minedia-www バックエンドに伝わります。本サイトはこの2系統の通信契約を1か所に集約します。
2つの通信プレーン
同期プレーン(リクエスト/レスポンス)
クライアント / フロント → minedia-www REST API
Session / Room / 参加トークン / 録画 / 文字起こし / 接続テスト等の操作。冪等・テナント分離・署名トークンの規約を持つ。
非同期プレーン(サーバーイベント)
LiveKit → minedia-www バックエンド (Webhook)
参加/退出・トラック・録画(egress) のサーバー通知。署名 JWT 検証・配信リトライ・冪等受信が前提。
横断規約サマリ
全エンドポイント/全イベントに共通する規約の要点。詳細は各ページを参照。
| 認証 | API: 署名トークン(Bearer)。Webhook: LiveKit 署名 JWT(生ボディ検証)。詳細は API 認証 |
|---|---|
| 冪等性 | API: 冪等キー。Webhook: イベント id を dedup キーに。詳細は API 冪等性 |
| テナント分離 | リソースはテナント単位で分離。詳細は API テナント分離 |
| エラー | 共通エラーコード体系。詳細は API エラーコード |