Skip to content

API 接入

WallaWhats 通过 JSON HTTP API 暴露与仪表板相同的操作。使用它来脚本化订阅管理、将通知历史拉入您自己的系统或将提醒与内部工具集成。每个付费层都包含 API 接入 — 请参见 管理套餐 了解每个套餐的密钥限制。

步骤 1 — 打开 API 密钥

在侧栏中,点击 API 密钥(在 访问密钥 下)。

有一个默认密钥的 API 密钥页面

步骤 2 — 创建密钥

  1. 点击 创建密钥
  2. 给密钥起一个 名称(例如 production-serverlocal-dev)。名称只是一个标签 — 不影响权限。
  3. 点击 创建

密钥的完整值仅显示 一次 — 立即将其复制到您的密码管理器。WallaWhats 仅存储一个哈希加上一个短前缀(bws_xxxxxxxx…),因此以后无法恢复。

像对待密码一样对待密钥

拥有密钥的任何人都可以在您的账号上行动。将密钥存储在密码管理器中,永远不要将它们提交到 git,并定期轮换。

步骤 3 — 使用密钥

在每个请求的 x-api-key 标头中发送密钥:

bash
curl -H "x-api-key: bws_xxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  https://api.wallawhats.com/subscriptions

可用的端点、请求主体和响应格式记录在 API 参考 中。

步骤 4 — 轮换或撤销

  • 轮换 — 创建一个新密钥,部署它,然后删除旧密钥。设计上没有"轮换"按钮;创建-然后-删除使切换原子化。
  • 撤销 — 点击密钥行旁边的 删除。密钥立即停止工作。任何正在进行的使用它的请求都会返回 401 Unauthorized

套餐限制

套餐API 密钥
Free1
Pro1
Pro+2
Business5
Enterprise20

如果达到限制,创建密钥 将被禁用 — 先删除旧密钥或升级您的套餐。

下一步

对于请求/响应模式和完整的端点列表,请参见 API 参考 →

WallaWhats Documentation