API概述
复制一个包含安装步骤和本插件的完整 Markdown 指南的配置提示。
这是 Capgo 云的公共 API 文档。 API 允许您程序化地管理您的 Capgo 资源,包括组织、设备、频道和捆绑包。它设计为 RESTful,使用标准 HTTP 方法。
身份验证
标题为“身份验证”的部分All API endpoints require authentication. To authenticate your requests, add your API key in the authorization 头中添加您的 __CAPGO_KEEP_1__ 密钥。
示例:
curl -H "authorization: your-api-key" https://api.capgo.app/organization/ 获取 API 密钥 在 Capgo 控制台中生成您的 API 密钥
速率限制
速率限制部分API 实现了速率限制,以确保公平使用。当前限制为:
- 标准帐户:每分钟 100 次请求
- 企业帐户:每分钟 1000 次请求
如果您超过这些限制,则会收到 429(Too Many Requests)响应。
或者 data object 或者是一个 status field. 错误响应包含一个 error field 描述了什么地方出了问题。
示例成功响应:
{ "status": "ok", "data": { ... }}示例错误响应:
{ "error": "Invalid API key", "status": "KO"}可用端点
标题:可用端点 组织 创建和管理组织,更新设置,处理组织级别配置
API Keys 生成、列出和撤销 API 密钥以安全访问 Capgo API
成员 管理组织成员、角色和权限
统计 查看有关应用使用情况、存储和带宽消耗的详细分析
频道 控制应用更新频道、捆绑包(版本)和更新策略
设备 跟踪和管理运行应用的设备,包括捆绑包(版本)和频道 assignments
捆绑包 处理应用捆绑包,包括上传、列出和管理捆绑包(版本)
最佳实践
最佳实践- 错误处理: 始终检查错误响应并适当处理
- 速率限制: 在遇到速率限制时实施指数退避
- 缓存: 在适当时缓存响应以减少API调用
- 版本控制: 通过我们的更改日志跟踪API的变更