Docs / API
API リファレンス
Bookmi のデータを既存のシステムへつなげます。POS、予約システム、自社 CRM のいずれとも連携できます。
インターフェース仕様は連携のご提案に合わせてお渡しします。認証方式、エンドポイント、フィールド構成は、つなぐシステムとデータの範囲によって変わるため、公開ページに固定の仕様書は掲載していません。ご用途をお知らせいただければ、対応する仕様書とテスト環境の認証情報をご用意します。
連携できるデータ
予約
予約の読み取りと書き込み。既存システムの予約を取り込むことも、Bookmi で受けた予約を送り出すこともできます。
- 予約一覧の取得
- 作成・変更・キャンセル
- 空き状況の照会
顧客カルテ
顧客の基本情報、会員・回数券、購入と来店の履歴。
- 顧客の検索・取得
- カルテの作成・更新
- 履歴の読み取り
通話記録
AI 電話の通話文字記録と受付結果。
- 通話一覧
- 通話詳細・文字記録
- 受付結果
Webhook
イベント発生時に指定の URL へ通知します。ポーリングは不要です。
- 新規予約
- 予約の変更・キャンセル
- 新規顧客
- 通話終了
- 低評価の口コミ
始め方
用途をお知らせください
どのシステムと、どのデータを、一方向か双方向か。
仕様書とテスト環境をお渡しします
ご用途に応じた仕様書をご提供し、テスト環境の認証情報を発行します。
連携と検証
テスト環境で動作を確認してから本番環境へ切り替えます。途中のご質問はいつでもどうぞ。
よくある質問
どのプランから API を使えますか?
Standard プラン以上で外部連携に対応します。連携可能な件数はプランによって異なります。詳細は料金ページをご覧いただくか、直接お尋ねください。
双方向の同期はできますか?
できます。既存システムの予約を Bookmi に取り込むことも、Bookmi で受けた予約を戻すことも可能です。同期の方向と競合時の扱いはご提案の中で決めます。
データ形式をこちらに合わせてもらえますか?
連携時にお客様のシステムに合わせてフィールドのマッピングを調整します。完全なカスタムワークフローは Pro・Enterprise プランの範囲です。
API の呼び出し回数に制限はありますか?
あります。上限はプランごとに設定しており、通常の業務量で達することはありません。具体的な数値は仕様書に記載します。
データの安全性はどう担保されますか?
通信は SSL/TLS で暗号化し、認証情報はいつでも失効・再発行できます。データは東京に保管し、国外には出さず、モデルの学習にも使いません。
※ インターフェース仕様は連携のご提案に合わせてお渡しするもので、本ページには固定のエンドポイントとフィールド定義は含まれません。セキュリティについて →
連携のご相談
つなぎたい内容をお聞かせください。仕様書とテスト環境をご用意します。
電話で相談する(050-1793-8198) →