APIリファレンス

このリファレンスでは、実在し公開利用が可能なJSONエンドポイントのみを説明します -- エンドポイントごとのメソッド、パス、認証タイプ、必須パラメーター、リクエストとレスポンスの例、および文書化されたエラーコードです。Zentorには汎用的な開発者向けAPIキーの仕組みはありません。アクセスはルートに応じて、認証なし、またはオリジン検証付きのウィジェット埋め込みトークンによって行われます。内部のダッシュボード用ルートとMaster Adminのエンドポイントは、通常のログインセッション経由でのみアクセスできるため、意図的にこの公開リファレンスには含まれていません。

各エンドポイントの項目には、その情報がレジストリスキーマ、自動テスト、実際のライブ観測のいずれに由来するかを明示するライブテスト注記が付いています -- 動作しているコードパスとの単なる類似は、完全な証明とは見なされません。また、技術的に成功した呼び出しが確認するのは常にそのリクエスト自体の処理のみであり、メール配信、支払いの完了、SSOログインの完了といった後続の処理まで自動的に確認するものではありません。

保護の方式はグループごとに異なります。公開されている法務、マーケティング、フォーム関連のエンドポイントには、ダッシュボードのセッションは不要です。一方、チャットウィジェットは `X-Widget-Token` ヘッダーとオリジン許可リストを使用します。ダッシュボードへのログインでは、有効期間12時間のセッションJWTと、7日間有効なリフレッシュトークンが発行されます。SSOエンドポイントは、独自のワンタイムコードとコールバックフローで動作します。

各エンドポイントのページは、それぞれ独立した契約として読んでください。重要なのは、HTTPメソッド、パス、必須パラメーター、データ型、リクエストボディ、レスポンス構造、エラーコード、べき等性です。例は想定されるフォーマットの一つを示すものであり、実際のレスポンスの確認に代わるものではありません。設定状態、バリデーション、権限、外部プロバイダーによって結果が変わる場合があります。

確認済みのプラットフォーム全体のレート制限は、15分あたり2,000リクエストです。エンドポイントごとの個別の制限は、すべてが文書化されているわけではありません。そのため、クライアントは不必要に短い間隔のポーリングループを使用しないでください。べき等でない操作では、自動リトライによってレコードやメッセージが重複する可能性があります。

機密性の高い値はログに記録しないでください。これにはパスワード、リセットトークン、検証コード、ウィジェットトークン、セッションID、実在の個人データを含むサンプルデータが該当します。ドキュメントやテストでは匿名化した値を使用してください。ライブテストの注記は、実際の証拠を正確に反映していなければなりません。