API概述

这是API的公共Capgo云的文档。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 仍然接受请求头，但

对于所有密钥类型，包括安全哈希密钥，

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

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

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

设备通道变化

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

• 设备可以在每个通道操作（set, get, delete，或”）中进行最多 5 次请求每秒。这个限制是针对应用、设备和操作的。 list将同一设备设置为同一通道超过一次在 60 秒内返回 429 响应。切换到不同的通道在每秒限制重置后是允许的。
• 每个应用和 IP 地址每分钟还有 1000 个通道请求的额外限制。
• __CAPGO_KEEP_0__

These limits are not account-wide. If your channel switcher can return to a recently selected channel, wait for the retryAfterSeconds duration in the 429 response before retrying.

响应格式

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

示例成功响应：

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

示例错误响应：

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

可用端点

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

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

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

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

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

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

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

最佳实践

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

继续从API概述

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