跳转到内容

API 概述

这是 Capgo cloud 公共 API 的文档。该 API 允许您以编程方式管理您的 Capgo 资源,包括组织、设备、渠道和捆绑包。它设计为 RESTful 并使用标准 HTTP 方法。

所有 API 端点都需要身份验证。要验证您的请求,请在 authorization 标头中添加您的 API 密钥。

示例:

Terminal window
curl -H "authorization: your-api-key" https://api.capgo.app/organization/

API 实施速率限制以确保公平使用。当前限制为:

  • 标准账户每分钟 100 个请求
  • 企业账户每分钟 1000 个请求

如果超过这些限制,您将收到 429 (Too Many Requests) 响应。

所有响应均为 JSON 格式。成功响应通常包括 data 对象或 status 字段。错误响应包括带有问题描述的 error 字段。

成功响应示例:

{
"status": "ok",
"data": { ... }
}

错误响应示例:

{
"error": "Invalid API key",
"status": "KO"
}
  1. 错误处理:始终检查错误响应并适当处理
  2. 速率限制:在达到速率限制时实施指数退避
  3. 缓存:在适当时缓存响应以减少 API 调用
  4. 版本控制:通过我们的更改日志跟踪 API 更改