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 是所有密钥类型（包括安全哈希密钥）的推荐标题。

速率限制

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

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

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

响应格式

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

复制到剪贴板

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

__CAPGO_KEEP_0__

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

可用端点

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

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

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

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

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

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

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

最佳实践

1. 始终检查错误响应并适当处理它们限速
2. 当达到限速时，实施指数回退缓存
3. 在适当的情况下缓存响应以减少__CAPGO_KEEP_0__调用API
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 (企业) 的实现细节