API 的概述

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

身份验证

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

示例：

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

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

The authorization header仍然接受用于遗留API密钥，但 x-api-key 是所有密钥类型，包括安全散列密钥的推荐header。

速率限制

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

• 每分钟100个请求对于标准帐户
• 每分钟1000个请求对于企业帐户

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

响应格式

对象或一个 data 对象或一个 status field. 错误响应包括一个描述错误情况的字段。 error field 有一个描述错误情况的描述。

Example success response:

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

Example error response:

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

Available Endpoints

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

API Keys 为安全访问CapgoAPI生成、列出和撤销API密钥

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

统计 查看应用使用情况、存储和带宽消耗的详细分析

频道 控制应用更新频道、版本包和更新策略

设备 跟踪和管理运行应用的设备，包括版本包和频道 assignments

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

最佳实践

1. 错误处理：始终检查错误响应并适当处理它们
2. 限速：在达到限速时实施指数退避
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 (企业) 中的实现细节为