コンテンツにスキップ
Delivery API
機能を前提に計画する前に、機能の提供状況をご確認ください。

リファレンス

ブラウザ向けエンドポイント

フォーム、チャットボット、ページビュー数のために、訪問者のブラウザが直接呼び出すエンドポイントです。

このページは英語から翻訳されたものです。内容に相違がある場合は、英語版が優先されます。 英語版を読む

これらのエンドポイントはトークンを必要としません。Atlas は、Origin ヘッダーが環境に登録されたウェブサイトのオリジンと一致するリクエストだけを受け付けます。それ以外は 403 ORIGIN_DENIED になります。CORS はそのオリジンに限定されます。

https://<delivery host>/v1/public/environments/{environmentId}
メソッドとパス 目的
GET /forms/{formKey} フォーム定義、設定、表示するチャレンジ
POST /forms/{formKey}/submissions 送信。ボディはフォームとリードをご覧ください
メソッドとパス 目的
GET /bots/{botKey} 外観とトリガー
POST /bots/{botKey}/conversations 開始: { path?, challengeToken? } → { conversationId, secret, messages }
POST /bots/{botKey}/conversations/{id}/messages 送信: { secret, text? (≤ 1,000 chars), choice?, challengeToken? }

428 BOT_CHALLENGE_REQUIRED は、ブラウザに Turnstile を完了して再試行するよう求めます。80 メッセージ後は 409 CONVERSATION_FULL です。チャットウィジェットがこれらをすべて処理します。

{ "path": "/about" } を付けた POST /analytics/views は 204 を返します。ページの読み込みやクライアントサイドのナビゲーションのたびに、fetch(…, { keepalive: true }) で送信してください。プレビューとボットは送信しないでください。

Atlas が保存するのはルートごとの日次カウントのみです。Cookie、IP アドレス、訪問者の識別子は保存しません。