API Reference

ⓘ

この機能をご利用いただける方

ストアフロント SDK はすべてのプランでご利用いただけます。キーは不要です。
API キーが必要なもの（GraphQL Customer API、Chat Conversations API、Webhook、MCP）は Pro または Plus プランが必要です。

Chatty では、ストアのチャットと顧客データを活用するための開発者向けインターフェースをご用意しています。

ツール	用途
GraphQL Customer API	連絡先と顧客データの読み取り。CRM、BI ツール、メール配信サービスへの同期に。
Chat Conversations API	ライブチャットの会話、メッセージ、タグ、メモの読み書き。
Webhooks	AI の返信や顧客のメッセージのリアルタイム通知。
Storefront SDK	ストアフロントからのチャットウィジェットの制御。開く、メッセージ送信、イベント計測。
MCP server	Claude などの AI アシスタントからの受信箱の読み取りと操作。

すべての API に共通する内容は Authentication（認証情報の仕組み）と Errors and Rate Limits（リクエストが失敗したときの対処）をご覧ください。

コードを書かずに使える連携をお探しの場合は、Klaviyo、Zendesk、Joy をご検討ください。

ⓘ

API 関連の詳細ページは現在英語のみのご提供です。上記のリンク先は英語ページに移動します。

認証情報はすべて設定 → 一般 → キーの管理（Settings → General → Manage keys）にまとまっています。

Key name に名前を入力します。そのキーを使うツール名にしておくと管理しやすくなります（例：Zendesk sync）。名前は 50 文字までです。入力したら Generate key をクリックします。

Key name の入力欄と Generate key ボタンが表示された「キーの管理」パネル

作成されたキーが sk_ から始まる完全な値とともに一覧に表示されます。

作成直後のキーが全文表示され、今すぐコピーするよう促すバナーが出ている画面

ページを離れる前に必ずキーをコピーしてください。 Chatty はキーのハッシュのみを保存するため、完全な値を再表示することはできません。紛失した場合は、そのキーを削除して新しいキーを作成してください。

1 つのストアにつき有効なキーを 5 個まで保持できます。連携ごとに 1 つずつ作成しておくと、他の連携に影響を与えずに 1 つだけ削除できます。

ⓘ

新しいキーが有効になるまで最大 5 分、削除したキーが無効になるまでも最大 5 分かかります。 作成直後の最初のリクエストが 401 になるのは想定どおりです。少し待ってから再度お試しください。

App ID は同じパネルの上部にあります。ツールによっては Client ID と呼ばれます。ストアを識別する値で、連携によってはキーと合わせて指定します。

「キーの管理」パネル上部の App ID 欄

API	送信するヘッダー
Chat Conversations API	`X-Api-Key: sk_...`
Webhooks の管理	`X-Api-Key: sk_...`
MCP server	`X-App-Id`（App ID）と `Authorization: Bearer sk_...`
GraphQL Customer API	`x-api-id`（App ID）と `x-api-secret`（シークレットキー）

連絡先をスプレッドシートに書き出す
GraphQL の customers クエリをページネーションと組み合わせて全連絡先を取得し、CSV に書き出します。

優良顧客をメール配信サービスに同期する
totalSpent で絞り込み、該当する顧客を各サービスの API 経由で登録します。

新しい顧客メッセージをチームに通知する
message.created Webhook を購読し、senderType が customer のときだけチームへ通知します。

ストアフロントにチャット操作を組み込む
SDK を使って、独自のボタンからチャットボックスを開いたり、メッセージをあらかじめ入力したりします。

API キーやリクエストで問題が発生した場合は、ダッシュボードから Chatty サポートチームにお問い合わせください。

Still need help?