API 参考

商户与用户

查找或登记 bookmi 的商户，查询、登记、停用该商户的用户。我们不保管密码，设置密码的邮件由 bookmi 发送。

• 商户的查找与登记
• 用户的查询・登记・停用
• 重发设置邮件

统一登录（SSO）

客户可以直接用 bookmi 账号登录你的服务。采用标准的授权码流程，返回带签名的 ID token。

• 授权码流程
• ID token（用公钥验证）
• 停用・锁定时会话失效

套餐与购买

获取该商户可用的套餐、加购和产品，生成套餐或积分包的购买链接。付款由商户本人在 bookmi 的确认页完成。

• 获取权益
• 套餐・积分包目录
• 生成购买链接
• 查询订单

积分与计量

把你的服务产生的用量，用商户的 bookmi 积分结算。也提供使用前的准入判定、余额和用量明细（对账用）。

• 准入判定
• 查询余额
• 用量计量
• 用量明细

知识检索

用问句检索商户的知识库。只读，不提供整库导出。

• 按问句检索

Webhook

发生变化时，带签名推送到你指定的 https 地址，无需轮询。

• 产品开通・停用
• 套餐购买・到期
• 积分购买
• 商户信息更新
• 用户停用・锁定・恢复

可以读写预约或顾客数据吗？

目前不提供。提供的是商户与用户、统一登录（SSO）、套餐与购买、积分计量、知识检索和事件推送。如需其他数据，请与我们沟通。

目前接入了哪些服务？

集团内的 AI 电话是第一个接入方。外部服务的接入，了解用途后可以商谈。

调用次数有上限吗？

有。按服务整体和每个商户两层设置上限（具体数值见说明文档）。超出时请按响应里的 Retry-After 等待后重试。

接口会变吗？

API 按版本管理。不兼容的变更会并行推出新版本，旧版本至少保留 6 个月。新增字段属于兼容变更，请忽略不认识的字段。

数据安全怎么保证？

通信使用 HTTPS（TLS）加密，密钥可随时作废和重新发放；Webhook 带签名。数据保存在东京的数据中心，bookmi 不会用于训练 AI 模型。详情请看「安全」页面。