Capgo Guía de referencia pública API JSON

A un JSON público API una interfaz que permite que el software intercambie datos estructurados a través de solicitudes y respuestas HTTP. Capgo’s JSON tipo, RESTful API da a los equipos de CapacitorJS y Electron control programático sobre actualizaciones en vivo, canales, paquetes y entrega de dispositivos.

Índice de Contenido

• Understanding Capgo Public API JSON Fundamentals
  • Entendiendo los Fondos de __CAPGO_KEEP_0__ JSON Público
  • ¿Qué controla la interfaz?

Understanding Capgo Public API JSON Fundamentals

Capgo isn’t a general-purpose data directory. Its public API JSON interface connects your build system with Capgo’s cloud delivery service, so release automation can publish and direct signed web bundles without waiting for App Store or Play review. REST uses familiar HTTP methods such as GET, POST, PUT, PATCH, y DELETEcon JSON como formato de respuesta, como se explica en esta Guía de REST API de Postman.

Para Capgo, JSON es el lenguaje compartido entre scripts de automatización, tareas de CI/CD, clientes de TypeScript y la plataforma de entrega. Esa consistencia hace que los payloads sean legibles en los registros y fáciles de validar antes de que comience una implementación.

¿Qué controla la interfaz?

Utilice los puntos finales de JSON públicos API para gestionar los recursos de lanzamiento operativo, incluyendo:

• Paquetes, los activos web y la metadata que componen una actualización desplegable.
• Canalescomo staging, beta, producción o flujos de lanzamiento específicos para clientes.
• Versions, que identifican y siguen los builds asignados a esos canales.
• Detección de dispositivo, que ayuda a dirigir las actualizaciones a plataformas, versiones de aplicaciones, sistemas operativos o grupos de metadatos seleccionados.
• Datos de observabilidad, incluyendo adopción, fallas, actividad de rollback y estado por dispositivo.

Una solicitud típica sigue una secuencia predecible. Su pipeline crea o prepara un paquete, envía metadatos JSON a Capgo, verifica el estado devuelto y luego asigna la versión a un canal apropiado. Una consulta posterior puede confirmar qué dispositivos recibieron la actualización.

Idea clave: Trate Capgo JSON como un contrato de control de versiones, no solo como un formato de datos. Cada campo debe apoyar la publicación, el enfoque, el monitoreo o la recuperación de una actualización de aplicación.

¿Por qué ayuda el JSON tipado?

Los payloads tipados reducen la ambigüedad en los códigobases de TypeScript. Un identificador de versión debe permanecer como una cadena, una bandera de lanzamiento debe permanecer como un Boolean y un recuento de dispositivos debe permanecer como numérico. Antes de conectar la automatización, defina interfaces para solicitudes y respuestas, luego valide los campos requeridos y los valores nulos.

Lee también: Aprende más sobre el uso de TypeScript con APIs.

Mantén tres hábitos en cada integración:

1. Inspecciona códigos de estado y cuerpos de respuesta juntos, porque el éxito HTTP solo puede describir la finalización de la implementación.
2. Preservar identificadores devueltosespecialmente los IDs de paquete, versión y canal, para llamadas posteriores.
3. Log safelyexcluyendo las claves API y los datos de dispositivo sensibles.

Las siguientes secciones de referencia utilizan esta base para explicar la autenticación, la carga de payloads, los esquemas de canal, las consultas de destino y los objetos de error. Para verificar los nombres de endpoint actuales y las definiciones de campo, consulte la documentación de Capgo en capgo.app.

{ “authorization”: “Bearer SU_CAPGO_API_LLAVE”, “contentType”: “application/json”, “accept”: “application/json” }

{ “success”: true, “bundleId”: “com.example.field-app”, “version”: “2.4.0”, “status”: “subido”, “bundleUuid”: “identificador-de-bundle-gerado”, “createdAt”: “2026-01-15T10:30:00Z” }

{ “versiónPredeterminada”: “2.4.3”, “actualizaciónAutomática”: true, “protecciónDeReiniciodeActualización”: { “habilitado”: true, “versiónDeFalla”: “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”: “PARAMETRO_INVALIDO”, “message”: “El campo ‘versión’ es obligatorio”, “field”: “versión”, “details”: { “esperado”: “cadena”, “recibido”: “nulo” } } }

{ “versión”: “2.4.0”, “checksum”: “sha256-value”, “cifrado”: true, “urlExterna”: “https://almacenamiento.ejemplo/bundle.zip” }