API 简介

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

认证

所有API端点都需要身份验证。要验证您的请求，请在请求中添加您的API密钥。 x-api-key header.

示例：

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

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

The authorization header仍然支持为遗留的API键。 x-api-key 是所有密钥类型，包括安全哈希密钥的推荐头

限制频率

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

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

如果您超过这些限制，您将接收到429（太多请求）响应。

设备通道变化

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

• 设备可以在每个通道操作中每秒最多发送5个请求（，或）。set, get, delete, or list设备可以在每个通道操作中每秒最多发送5个请求（，或）。此限制仅适用于应用、设备和操作。
• 设置相同设备到相同频道超过一次在60秒内返回429响应。切换到不同的频道在每秒限制重置后允许。
• 每个应用程序和IP地址每分钟有1000个频道请求限制。

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

响应格式部分

示例成功响应： data 复制到剪贴板 status __CAPGO_KEEP_0__ error __CAPGO_KEEP_1__

__CAPGO_KEEP_2__

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

示例错误响应：

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

可用端点

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

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

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

统计信息 访问有关应用程序使用、存储和带宽消耗的详细分析

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

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

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

最佳实践

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

继续阅读API概述

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