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 标题仍然接受旧版API键，但 x-api-key 是所有键类型，包括安全散列键的推荐标题。

限速

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

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

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

响应格式

100 requests per minute for standard accounts data 对象或一个字段。错误响应包括一个描述错误发生原因的字段。 status field. 错误响应包括一个描述错误发生原因的字段。 error 示例成功响应：

复制到剪贴板

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

复制到剪贴板

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

标题：可用端点

创建和管理组织，更新设置，处理组织级别配置 Capgo保留的键

API Keys 生成、列出和撤销 API 密钥以安全访问 Capgo 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 中了解实现细节。