API概述

本文档描述了 Capgo 公共 API 的 API 部分。 Capgo 公共 API 是 Capgo 云的 API 部分，允许您程序化地管理您的 Capgo 资源，包括组织、设备、频道和包。它遵循 RESTful 设计，使用标准 HTTP 方法。

身份验证

All API endpoints require authentication. To authenticate your requests, add your API key in the x-api-key 头部

示例：

curl -H "x-api-key: YOUR_API_KEY" https://api.capgo.app/organization/

获取API密钥 在Capgo控制台中生成您的API密钥

头部仍然接受遗留__CAPGO_KEEP_0__密钥，但 authorization header is still accepted for legacy API keys, but x-api-key Legacy__CAPGO_KEEP_0__ keys

速率限制

API 实现了速率限制，以确保公平的使用。当前限制是：

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

如果您超过这些限制，您将会收到429（Too Many Requests）响应。

设备通道变化

设备通道变化使用插件API，并且每个计划，包括试用版，都有单独的防止滥用的限制：

• 每个通道操作（，或）每秒最多5个请求。该限制是针对应用、设备和操作的。set, get, delete] list速率限制
• 设置相同设备到相同频道超过一次在60秒内返回429响应。切换到不同的频道在每秒限制重置后允许。
• 每个应用程序和IP地址每分钟有1000个频道请求的额外限制。

这些限制不是账户级别的。如果您的频道切换器可以返回到最近选择的频道，请等待429响应中的持续时间再重试。 retryAfterSeconds 响应格式

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

复制到剪贴板 data 频道切换限制 status 频道请求限制 error 频道切换限制

响应格式

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

示例错误响应：

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

可用端点

组织 创建和管理组织，更新设置，处理组织级别配置

API 密钥 生成、列出和撤销 API 密钥以安全访问 Capgo API

成员 管理组织成员，角色和权限

统计 获取有关应用程序使用、存储和带宽消耗的详细分析

频道 控制应用程序更新频道、版本包（版本）和更新策略

设备 跟踪和管理运行应用程序的设备，包括版本包（版本）和频道分配

版本包 处理应用程序版本包，包括上传、列出和管理版本包（版本）

最佳实践

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

继续阅读API概述

如果您正在使用 API概述 来规划身份验证和帐户流程，连接它与 capgo/capacitor-social-login 了解@capgo/capacitor-social-login的实现细节 @capgo/capacitor-passkey 为 @capgo/capacitor-passkey 的实现细节 @capgo/capacitor-native-biometric 为 @capgo/capacitor-native-biometric 的实现细节 双因素认证 为双因素认证和 SSO (企业) 为 SSO (企业) 的实现细节