REST API 提供对贵公司数据的编程访问。它面向构建集成的开发人员;日常使用无需用到。
- API 参考:完整参考在您工作区地址的 /docs/api 处公开提供,OpenAPI 文档位于 /docs/api/openapi.yaml 和 /docs/api/openapi.json。设置中的 API 与 Webhook 提供了链接。
- 基础 URL:显示在 API 与 Webhook 的顶部。它以 /api/v1 结尾。
- 身份验证:发送请求头 Authorization: Bearer 后接您的令牌,以及 Accept: application/json。
- 响应:仅限 JSON。单条记录包装在 data 中;列表另含 meta 和 links,用于游标分页(limit 和 cursor 参数,每页最多 100 条)。
- 安全重试:在 POST 请求中发送 Idempotency-Key 请求头。使用相同的键重复同一请求时,会返回已存储的响应,而不是创建第二条记录。键会保留 24 小时。
- 速率限制:每个令牌每分钟 120 个请求。X-RateLimit-Limit 和 X-RateLimit-Remaining 响应头显示您的当前用量;超出限制时会返回 429 及 Retry-After 响应头。
请求可以做什么
只有当令牌拥有相应权限(例如 invoices:write)且令牌所属用户在应用中拥有对应权限时,调用才会成功。适用与界面上相同的业务规则,因此已开具的发票同样无法通过 API 编辑。