创建 API 密钥并选择权限
如何为你的网站或管理软件创建密钥、每个权限能做什么,以及如何撤销。
开始之前
- 公共 API 是增值服务:先在店铺的套餐和服务里开通。
- 需要「创建和撤销 API 密钥」权限。店主始终拥有。
创建密钥
- 进入 设置 › 商品与数据 › API 与开发者。
- 点 新建密钥,起一个能说明用途的名字(例如「店铺官网」)。
- 只勾选对接需要的权限。
- 如果对接总是从固定的机器调用,填写它们的 IP 或网段(例如
203.0.113.0/24)。留空 = 任何 IP。 - 如果只是测试,设置到期日。
- 点 创建密钥,再点 复制。完整密钥只显示这一次:请妥善保存。
每个权限能做什么
products:read:商品、变体和价格。stock:read:可售库存和各仓库数量。customers:read和customers:write:查看客户;新建和修改客户。orders:read和orders:write:查看订单及其票据;新建订单(先挂单,等你确认)。documents:read:发票、小票、更正发票和 Albarán 及其 PDF。
密钥的权限永远不会超过创建它的人:如果取消这个人的某个权限,密钥也会同时失去。
撤销
点密钥旁边的 撤销。立即失效且不能恢复:需要时再新建一个。创建和撤销密钥会记入审计日志和敏感操作。每家店最多 10 个有效密钥。