文档

快速入门

约定

  • 下面所有路径都相对于基础 URL。请求和响应均为 JSON；POST 时请发送 Content-Type: application/json。
  • ID 为 UUID。时间戳为 UTC 的 ISO 8601 格式。
  • 占位符通过其键寻址，即模板端点在每个标签旁返回的 snake_case 名称，例如 client_name。它在模板首次保存时由标签派生，标签改写后保持不变；作者可以在模板中更改它。
  • 响应带有 Cache-Control: no-store 和宽松的 CORS 头，所以浏览器客户端可以工作，但浏览器不是存放 API 令牌的合适位置。
  • API 在路径中标注版本。响应可以在不更改版本的情况下新增字段；v1 内不会移除或重命名任何内容。