第 8 节，共 12 节

集成与 API

通过外部 REST API 将 Buqq 与你的 POS 或自定义工具集成。

集成部分提供了一个外部 REST API，供你与 POS 系统或其他工具构建自定义集成。可以从仪表板 → 集成进入。

完整的 API 参考——包括接口结构、身份验证细节和示例——可以在buqq.online/api-docs 查看。
Telegram 预订提醒在设置 → 通知中设置。设置步骤请参阅本指南的设置部分。

商家 ID#

你的商家 ID 是你在 Buqq 平台上账户的唯一标识符。它会显示在集成页面，联系客服或使用某些 API 端点时都需要用到它。

API 密钥#

Buqq 外部 API 让你可以从自己的系统读取可用性、创建预订并更新预订状态。使用 API 需要一个 关联到你商家账户的 API 密钥。

生成密钥

  1. 在“仪表板 → 集成”中，滚动到“API 密钥”部分。
  2. 点击“生成 API 密钥”。
  3. 复制该密钥，并将其保存在你的环境变量或密钥管理工具中。
将你的 API 密钥当作密码来对待——不要分享，也不要提交到版本控制系统中。如果你怀疑某个密钥已泄露， 请立即将其吊销并生成一个新的。

显示当前密钥

如果你需要获取现有密钥，点击显示——完整密钥就会显示出来，方便你再次复制。

轮换密钥

轮换会用一个新密钥替换你当前的密钥。旧密钥会立即失效。轮换前请先更新所有使用旧密钥的集成。

吊销密钥

吊销会删除当前密钥，且不会颁发新密钥。在你生成新密钥之前，API 调用都会失败。如果你怀疑某个 密钥已泄露，请使用吊销操作。

cURL 代码片段#

集成页面提供了可直接使用的 cURL 代码片段，覆盖最常见的 API 操作。将 YOUR_API_KEY 替换为你实际的密钥即可立即测试。

示例 —— 查询可用性

curl https://buqq.online/api/external/v1/availability \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -G -d "date=2025-08-15" -d "party_size=2"

POS 说明#

如果你正在将 Buqq 与 POS 系统连接，外部 API 支持从你的 POS 读取今天已确认的预订， 以及更新预订状态（例如将预订标记为已登记或已取消）。具体的集成步骤请参考你 POS 厂商的文档，端点详情请参阅 API 文档。

GET /api/external/v1/availability
返回指定日期和人数下的可用时段。
GET /api/external/v1/bookings
列出你餐厅的预订。可按日期筛选。
POST /api/external/v1/bookings
以编程方式创建一笔新预订。
PATCH /api/external/v1/bookings/{id}/status
更新预订状态（confirmed、checked_in、cancelled、no_show）。