チャットウィジェット
顧客のウェブサイト上で埋め込みチャットウィジェットを使用するすべてのエンドポイント。
このグループは、顧客のウェブサイト上で埋め込みチャットウィジェットが使用するすべての公開エンドポイントをまとめたものです。具体的には、到達性チェック(`GET /api/public/widget/health`)、公開ウィジェット設定の取得(`GET /api/public/widget/config/:widget_code`)、メッセージ送信および履歴(`POST /api/public/widget/message`、`GET /api/public/widget/history`)が含まれます。ドメインの共有は、ウィジェットの作成時にZentorによって管理されます。テナントダッシュボードに設定インターフェースは存在しません。オリジンが共有されていない場合、エラーコード `WIDGET_ORIGIN_DENIED` が発生する可能性があります。ウィジェットの作成自体はマスター管理者に限定されており、テナントは完成した埋め込みコードを受け取ります。
一般的な開発者用APIキーシステムは存在しません。`health` および `config` はブラウザ上でウィジェットを初期化する目的で、認証なしでアクセス可能です。一方、`message` と `history` は `X-Widget-Token` ヘッダーを必要とし、さらにサーバー側のオリジン許可リストに対して検証されます。埋め込みトークンは、ウィジェット作成時に一度だけ平文で表示され、公開リポジトリ、サポートのスクリーンショット、またはブラウザログに含めてはいけません。
このグループの各詳細ページでは、各エンドポイントのメソッド、パス、認証方式、冪等性、および文書化されたエラーコードを個別に説明します。あるエンドポイントの呼び出しが成功したからといって、同じグループの他のエンドポイントも成功するとは限りません。特に、緑色の `health` チェックが成功したとしても、有効なウィジェット、共有されたオリジン、またはAIプロバイダーの到達性を保証するものではありません。
プラットフォーム全体のAPI制限は、15分以内に2,000リクエストと確認されています。個別のウィジェットエンドポイントに対して異なる制限がある場合は、そのエンドポイントに対して明示的に文書化されている場合のみ記載されます。`message` は冪等性を持ちません。クライアントは、送信処理が不明確な理由で中断された場合でも、最初のメッセージがすでに処理されたかどうかを確認せずに自動的に再試行してはいけません。
このグループの技術的な検証は、`app/frontend/src/content/api-reference/groups/widget.ts` 内のレジストリおよび関連するバックエンドルートに基づいています。各詳細ページでは、成功パスがライブで検証されたか、失敗パスが検証されたか、または単なるコードの類似検証にとどまったかが明記されます。この区別はグループ全体に適用され、包括的な成功の主張で置き換えてはいけません。