API 介绍

This is the documentation of the public API of Capgo cloud. The API allows you to programmatically manage your Capgo resources, including organizations, devices, channels, and bundles. It’s designed to be RESTful and uses standard HTTP methods.

身份验证

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/

Get API key Generate your API key in the Capgo dashboard

头部仍然接受遗留 Capgo 密钥，但 authorization header is still accepted for legacy API keys, but x-api-key 所有密钥类型，包括安全散列密钥，应使用以下头部：

速率限制

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

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

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

设备通道更改

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

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

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

标题：响应格式

成功响应示例： data __CAPGO_KEEP_0__ status __CAPGO_KEEP_1__ error __CAPGO_KEEP_2__

__CAPGO_KEEP_3__

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

示例错误响应：

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

可用端点

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

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

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

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

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

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

跟踪和管理运行应用的设备，包括包（版本）和频道 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 (企业)的实现细节。