跳过内容

API 概述

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

身份验证

认证

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

示例:

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

速率限制

认证

The API implements rate limiting to ensure fair usage. Current limits are:

  • 每分钟100次请求(标准账户)
  • __CAPGO_KEEP_0__

__CAPGO_KEEP_1__

__CAPGO_KEEP_2__

__CAPGO_KEEP_3__

所有企业帐户每分钟 1000 次请求 data 如果超过这些限制,您将收到 429(Too Many Requests)响应。 status __CAPGO_KEEP_4__ error 响应格式

所有响应均为 JSON 格式。成功响应通常包含一个对象或一个字段。错误响应包含一个字段,描述了发生了什么错误。

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

复制到剪贴板

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

可用端点

可用端点

最佳实践

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