Docs ／ API

API リファレンス

Bookmi のアカウント・契約・ポイント・ナレッジを、あなたの製品やサービスとつなぐ開放平台の API です。Bookmi のアカウントでのログイン（SSO）、契約内容の確認と購入リンク、ポイントの計量、ナレッジ検索、イベント通知を提供しています。

エンドポイント・認証方式・フィールドの仕様書と、テスト環境の鍵は、接続のご相談のうえでお渡しします。グループ内の製品と外部のサービスとでは認証の方式が異なるため、ご用途に合わせた仕様書をご用意します。

提供している API

事業者とユーザー

Bookmi の事業者を照合・登録し、その事業者のユーザーを照会・登録・停止します。パスワードはお預かりせず、設定用のメールを Bookmi からお送りします。

ログイン（SSO）

お客様が Bookmi のアカウントのまま、あなたのサービスにログインできます。標準的な認可コードフローで、署名付きの ID トークンをお返しします。

契約と購入

その事業者が使えるプラン・オプション・製品を取得し、プランやポイントパックの購入リンクを発行します。お支払いは事業者ご本人が Bookmi の確認画面で行います。

ポイントと計量

あなたのサービスで使った分を、事業者の Bookmi ポイントで精算します。利用前の可否判定、残高、利用明細（突き合わせ用）もそろっています。

ナレッジ検索

事業者のナレッジベースを質問文で検索します。読み取りのみで、一括の書き出しはしません。

Webhook

変化があった時に、指定の URL（https）へ署名付きで通知します。ポーリングは不要です。

ご用途をお知らせください

どの製品・サービスと、どの範囲（ログイン・契約・ポイント・ナレッジ・通知）をつなぐか。

仕様書とテスト環境の鍵をお渡しします

仕様書と、テスト用の事業者を作れるサンドボックスの鍵を発行します。

つないで確かめる

サンドボックスで動作を確かめてから、本番の鍵に切り替えます。途中のご質問はいつでもどうぞ。

予約や顧客のデータを読み書きできますか？

現時点では提供していません。提供しているのは、事業者とユーザー、ログイン（SSO）、契約と購入、ポイントの計量、ナレッジ検索、イベント通知です。必要なデータがあればご相談ください。

どんなサービスがつながっていますか？

グループ内の AI 電話が最初の接続先です。外部のサービスとの接続は、用途を伺ったうえでご相談に応じます。

呼び出し回数に上限はありますか？

あります。サービス全体と事業者ごとの 2 段階で上限を設けています（数値は仕様書に記載）。超えた時は、応答の Retry-After に従って待ってから再試行してください。

仕様が変わることはありますか？

API はバージョンで管理しています。互換性のない変更は新しいバージョンを並行して出し、旧バージョンは最低 6 か月残します。項目の追加は互換性のある変更として行うので、知らない項目は無視してください。

データの安全性はどう担保されますか？

通信は HTTPS（TLS）で暗号化し、鍵はいつでも失効・再発行できます。Webhook には署名を付けます。データは東京のデータセンターに保管し、Bookmi が AI モデルの学習に使うことはありません。詳しくは「セキュリティ」のページをご覧ください。

※ エンドポイントとフィールドの定義は仕様書に記載しています。本ページは提供範囲のご案内です。セキュリティについて →

連携のご相談

つなぎたい内容をお聞かせください。仕様書とテスト環境をご用意します。