Una JSON público de API interface permite que el software intercambie datos estructurados mediante peticiones y respuestas HTTP. La API RESTful y tipada de Capgo ofrece a los equipos de CapacitorJS y Electron control programático sobre live updates, canales, bundles y la entrega al dispositivo.
Índice de contenidos
Fundamentos de la API JSON pública de Capgo
Capgo no es un directorio de datos genérico. Su interfaz API JSON pública conecta tu sistema de build con el servicio de entrega en la nube de Capgo, así la automatización de releases puede publicar y dirigir web bundles firmados sin esperar la revisión de App Store o Play. REST usa métodos HTTP conocidos como GET, POST, PUT, PATCH y DELETE, donde el JSON suele ser el formato de respuesta, como se explica en esta guía de la API REST de Postman.
Para Capgo, JSON es el lenguaje común entre scripts de automatización, jobs de CI/CD, clientes de TypeScript y la plataforma de entrega. Esa consistencia hace que los payloads sean legibles en los logs y fáciles de validar antes de iniciar un deployment.
Qué controla la interfaz
Usa los endpoints JSON públicos de API para gestionar recursos operativos de release, incluyendo:
- Bundles, los assets web y metadatos que componen una actualización desplegable.
- Canales, como staging, beta, producción o canales de release específicos para clientes.
- Versiones, que identifican y rastrean los builds asignados a esos canales.
- Segmentación de dispositivos, que ayuda a dirigir los releases a plataformas, versiones de app, sistemas operativos o grupos de metadatos seleccionados.
- Datos de observabilidad, incluyendo adopción, fallos, actividad de rollback y estado por dispositivo.
Una petición típica sigue una secuencia predecible. Tu pipeline crea o prepara un bundle, envía metadatos JSON a Capgo, verifica el status devuelto y asigna el release al canal correspondiente. Una consulta posterior puede confirmar qué dispositivos recibieron la update.
Idea clave: Considera el JSON de Capgo como un contrato de control de lanzamientos, no solo como un formato de datos. Cada campo debe permitir publicar, dirigir, monitorear o recuperar una actualización de la aplicación.
Por qué ayuda el JSON tipado
Los payloads tipados reducen la ambigüedad en codebases de TypeScript. Un identificador de versión debe ser un string, un flag de rollout un Boolean y el conteo de dispositivos un número. Antes de conectar la automatización, define interfaces para requests y responses, y valida los campos requeridos y valores nulos.
Lee también: Más información sobre el uso de TypeScript con APIs.
Mantén tres hábitos en cada integración:
- Inspecciona status codes y response bodies juntos, ya que un HTTP exitoso no garantiza que el despliegue haya finalizado.
- Preserva los identificadores devueltos, especialmente los IDs de bundle, version y channel, para llamadas posteriores.
- Log safely, excluyendo las keys de API y datos sensibles del dispositivo.
Las siguientes secciones de referencia usan esta base para explicar la autenticación, upload de payloads, esquemas de canales, queries de targeting y objetos de error. Para nombres de endpoints y definiciones de campos actuales, verifica la documentación de Capgo en capgo.app.
{\n“authorization”: “Bearer TU_CAPGO_API_KEY”,\n“contentType”: “application/json”,\n“accept”: “application/json”\n}
{\n“success”: true,\n“bundleId”: “com.example.field-app”,\n“version”: “2.4.0”,\n“status”: “uploaded”,\n“bundleUuid”: “generated-bundle-identifier”,\n“createdAt”: “2026-01-15T10:30:00Z”\n}
{\n“defaultVersion”: “2.4.3”,\n“autoUpdate”: true,\n“rollbackProtection”: {\n“enabled”: true,\n“fallbackVersion”: “2.4.2”\n}\n}
{ “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”: “INVALID_PARAMETER”, “message”: “El campo ‘version’ es obligatorio”, “field”: “version”, “details”: { “expected”: “string”, “received”: “null” } } }
{\n“version”: “2.4.0”,\n“checksum”: “sha256-value”,\n“encryption”: true,\n“externalUrl”: “"}https://storage.example/bundle.zip}” }
