跳过内容

API概述

这是 Capgo 云的公共 API 文档。 API 允许您程序化地管理您的 Capgo 资源,包括组织、设备、频道和捆绑包。它设计为 RESTful,使用标准 HTTP 方法。

All API endpoints require authentication. To authenticate your requests, add your API key in the authorization 头中添加您的 __CAPGO_KEEP_1__ 密钥。

示例:

终端窗口
curl -H "authorization: your-api-key" https://api.capgo.app/organization/

速率限制

速率限制部分

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

  • 标准帐户:每分钟 100 次请求
  • 企业帐户:每分钟 1000 次请求

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

或者 data object 或者是一个 status field. 错误响应包含一个 error field 描述了什么地方出了问题。

示例成功响应:

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

示例错误响应:

{
"error": "Invalid API key",
"status": "KO"
}

最佳实践

最佳实践
  1. 错误处理: 始终检查错误响应并适当处理
  2. 速率限制: 在遇到速率限制时实施指数退避
  3. 缓存: 在适当时缓存响应以减少API调用
  4. 版本控制: 通过我们的更改日志跟踪API的变更