API 介绍

这是 API 的公共文档，Capgo 云的。API 允许您程序化地管理您的 Capgo 资源，包括组织、设备、频道和包。

身份验证

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 是所有密钥类型的推荐标题，包括安全散列密钥。

速率限制

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

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

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

设备通道更改

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

• 每个通道操作每秒最多可以发送5个请求（例如，set, get, delete] list. 这个限制是针对应用、设备和操作的。
• 设置相同的设备到相同的频道超过一次，60秒内会返回429响应。切换到不同的频道在每秒限制重置后是允许的。
• 每个应用和IP地址每分钟还会应用一个额外的1000个频道请求限制。

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

标题：响应格式

示例成功响应： data 示例成功响应： status 示例成功响应： error 示例成功响应：

示例成功响应：

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

示例错误响应：

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

可用端点

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

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

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

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

频道 上下文:Capgo发布频道功能名称。页面/区域:Capgo解决方案营销页面。角色:短的UI标签或导航项。见于页面解决方案/白标签.astro。消息键`solutions_white_label_visual_cell2_value` (解决方案白标签视觉单元2值)。

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

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

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

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 的实现细节 双因素认证 为双因素认证的实现细节, 和 SAML (企业) 为 SAML (企业) 的实现细节。