API 參考

商戶與使用者

查詢或登記 bookmi 的商戶，查詢、登記、停用該商戶的使用者。我們不保管密碼，設定密碼的郵件由 bookmi 傳送。

• 商戶的查詢與登記
• 使用者的查詢・登記・停用
• 重發設定郵件

統一登入（SSO）

客戶可以直接用 bookmi 帳號登入你的服務。採用標準的授權碼流程，返回帶簽名的 ID token。

• 授權碼流程
• ID token（用公鑰驗證）
• 停用・鎖定時會話失效

套餐與購買

獲取該商戶可用的套餐、加購和產品，生成套餐或積分包的購買連結。付款由商戶本人在 bookmi 的確認頁完成。

• 獲取權益
• 套餐・積分包目錄
• 生成購買連結
• 查詢訂單

積分與計量

把你的服務產生的用量，用商戶的 bookmi 積分結算。也提供使用前的准入判定、餘額和用量明細（對帳用）。

• 准入判定
• 查詢餘額
• 用量計量
• 用量明細

知識檢索

用問句檢索商戶的知識庫。只讀，不提供整庫匯出。

• 按問句檢索

Webhook

發生變化時，帶簽名推送到你指定的 https 地址，無需輪詢。

• 產品開通・停用
• 套餐購買・到期
• 積分購買
• 商戶資訊更新
• 使用者停用・鎖定・恢復

可以讀寫預約或顧客資料嗎？

目前不提供。提供的是商戶與使用者、統一登入（SSO）、套餐與購買、積分計量、知識檢索和事件推送。如需其他資料，請與我們溝通。

目前接入了哪些服務？

集團內的 AI 電話是第一個接入方。外部服務的接入，瞭解用途後可以商談。

呼叫次數有上限嗎？

有。按服務整體和每個商戶兩層設定上限（具體數值見說明文件）。超出時請按響應裡的 Retry-After 等待後重試。

介面會變嗎？

API 按版本管理。不相容的變更會並行推出新版本，舊版本至少保留 6 個月。新增欄位屬於相容變更，請忽略不認識的欄位。

資料安全怎麼保證？

通訊使用 HTTPS（TLS）加密，金鑰可隨時作廢和重新發放；Webhook 帶簽名。資料保存在東京的資料中心，bookmi 不會用於訓練 AI 模型。詳情請看「安全」頁面。