A 公共 API JSON 接口允许软件通过 HTTP 请求和响应交换结构化数据。 Capgo 的类型化、RESTful API 为 CapacitorJS 和 Electron 团队提供了对实时更新、频道、捆绑包和设备交付的编程控制。
目录
理解 Capgo 公共 API JSON 基础
Capgo 不是通用数据目录。其公共 API JSON 接口连接您的构建系统与 Capgo 云交付服务，使发布自动化能够发布和指示已签名的 Web 捆绑包，而无需等待 App Store 或 Play 审核。REST 使用熟悉的 HTTP 方法，如 GET、POST、PUT、PATCH 和 DELETE GET、POST、PUT、PATCH 和 DELETE,JSON 通常作为响应格式，正如本文所解释的 REST API 指南来自 Postman.
对于 Capgo，JSON 是自动化脚本、CI/CD 任务、TypeScript 客户端和交付平台之间共享的语言。这种一致性使得负载在日志中可读，并且在部署开始之前可以轻松验证。
界面控制项
使用公共 API JSON 端点管理运营发布资源，包括：
- 捆绑包，即构成可部署更新的 Web 资产和元数据。
- 发布渠道，例如预发布、测试、生产或客户专用发布流。
- 版本，用于识别和跟踪分配给这些渠道的构建。
- 设备目标，帮助将发布指向所选平台、应用程序版本、操作系统或元数据组。
- 可观察性数据一个典型的请求遵循可预测的序列。管道创建或准备一个捆绑包，发送JSON元数据到__CAPGO_KEEP_0__，检查返回的状态，然后将发布指派给适当的频道。稍后可以确认哪些设备接收了更新。
A typical request follows a predictable sequence. Your pipeline creates or prepares a bundle, sends JSON metadata to Capgo, checks the returned status, and then assigns the release to an appropriate channel. A later query can confirm which devices received the update.
核心思想 将Capgo JSON 视为发布控制协议，而不是仅仅是一种数据格式。每个字段都应支持发布、目标、监控或恢复应用程序更新。
类型化负载减少了 TypeScript 代码库中的不确定性。版本标识符应保持为字符串，滚动标志应保持为布尔值，设备计数应保持为数字。在连接自动化之前，定义请求和响应的接口，然后验证必填字段和可空值。
阅读更多：
也可以阅读 在每个集成中保持三个习惯：.
检查状态代码和响应体一起
- 可观察性数据因为 HTTP 成功并不一定能描述部署完成。
- 保留返回的标识符特别是 bundle、版本和渠道 ID，用于后续的调用。
- 安全地记录排除 API 键和敏感设备数据。
以下参考部分基于此基础来解释身份验证、上传负载、渠道模式、目标查询和错误对象。要获取当前端点名称和字段定义，请参阅 Capgo 的文档在 capgo.app.
{ “authorization”: “Bearer YOUR_CAPGO_API_KEY”, “contentType”: “application/json”, “accept”: “application/json” }
{ “success”： true, “bundleId”： “com.example.field-app”， “version”： “2.4.0”， “status”： “已上传”， “bundleUuid”： “生成的包标识符”， “createdAt”： “2026-01-15T10:30:00Z” }
{ “默认版本”： “2.4.3”， “自动更新”： true, “回滚保护”： { “开启”： true, “回退版本”： “2.4.2” } }
{ “data”: [ { “timestamp”: “2026-02-04T09:00:00Z”, “installs”: 842, “rollbacks”: 3, “errors”: 11 }, { “timestamp”: “2026-02-04T10:00:00Z”, “installs”: 1276, “rollbacks”: 2, “errors”: 8 } ], “summary”: { “totalInstalls”: 2118, “totalRollbacks”: 5, “totalErrors”: 19 } }
{ “error”：{ “code”：“参数无效”， “message”：“缺少‘version’字段”， “field”：“version”， “details”：{ “expected”：“字符串”， “received”：“null” } }
{ “version”: “2.4.0”， “checksum”: “sha256-value”， “encryption”: true， “externalUrl”: “”}https://storage.example/ bundle.zip” }
