連携API
予約や注文の後に一回呼び出すだけで、Citypickedがレビューをお願いする。評価と非公開フィードバックはWebhookで返ってくる。
リクエスト
POST /v1/requests Authorization: Bearer cp_live_… Idempotency-Key: booking-4711 { "channel": "sms", "consent": true, "contacts": [{ "name": "佐藤恵美", "phone": "+12015550123" }] }
レスポンス 201
{ "created": 1,
"results": [{ "outcome": "created", "request_id": "…" }] }Webhook
必要なイベントにURLを登録する。配信にはすべて署名が付き、数秒以内に届く。
署名を検証
Citypicked-Signature: t=1762594200,v1=5f2c… const expected = crypto .createHmac("sha256", secret) .update(`${t}.${rawBody}`) .digest("hex");
URLが2xxで応答しないときは、約18時間かけてさらに六回送り直す。
エンドポイント
読み取りはどのキーでもできる。送信にはsendスコープのあるキーが必要。
最初の呼び出しの前に
追加料金はなし。読み取りはすべてのプランで使え、APIからの送信はProから。SMSはアプリと同じくクレジットを使い、メールは使わない。
できる。send_atで30日先まで送信日時を指定できる。それまでは、予約がなくなったときなどに、一回の呼び出しで取り消せる。
不要。依頼やフィードバックを取得することもでき、sinceを使えば新しいものだけを取れる。Webhookなら何度も問い合わせる手間がなく、すぐに届く。
channelをwhatsappにすると、リンクが返ってくる。チームが自分のスマートフォンでそれを開き、アプリと同じようにメッセージを自分で送る。
ある。すべてのエンドポイントのOpenAPI 3.1仕様を、キーなしで取得できる。