Descripción general de la API

Esta es la documentación de la API pública de Capgo cloud. La API le permite gestionar programáticamente sus recursos de Capgo, incluyendo organizaciones, dispositivos, canales y paquetes. Está diseñada para ser RESTful y utiliza métodos HTTP estándar.

Autenticación

Todos los endpoints de la API requieren autenticación. Para autenticar sus solicitudes, agregue su clave API en el encabezado authorization.

Ejemplo:

curl -H "authorization: your-api-key" https://api.capgo.app/organization/

Obtener clave API Genere su clave API en el panel de Capgo

Límite de velocidad

La API implementa límites de velocidad para garantizar un uso justo. Los límites actuales son:

• 100 solicitudes por minuto para cuentas estándar
• 1000 solicitudes por minuto para cuentas empresariales

Si excede estos límites, recibirá una respuesta 429 (Too Many Requests).

Formato de respuesta

Todas las respuestas están en formato JSON. Las respuestas exitosas generalmente incluyen un objeto data o un campo status. Las respuestas de Error incluyen un campo error con una descripción de lo que salió mal.

Ejemplo de respuesta exitosa:

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

Ejemplo de respuesta de Error:

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

Endpoints disponibles

Organizaciones Cree y gestione organizaciones, actualice configuraciones y maneje configuraciones a nivel de organización

Claves API Genere, liste y revoque claves API para acceso seguro a la API de Capgo

Miembros Gestione miembros de la organización, roles y permisos

Estadísticas Acceda a análisis detallados sobre el uso de la aplicación, almacenamiento y consumo de ancho de banda

Canales Controle los canales de actualización de aplicaciones, versiones y políticas de actualización

Dispositivos Rastree y gestione dispositivos que ejecutan su aplicación, incluyendo asignaciones de versión y canal

Paquetes Maneje paquetes de aplicaciones, incluyendo carga, listado y gestión de versiones

Mejores prácticas

1. Manejo de errores: Siempre verifique las respuestas de Error y manéjelas apropiadamente
2. Límite de velocidad: Implemente backoff exponencial al alcanzar los límites de velocidad
3. Almacenamiento en caché: Almacene en caché las respuestas cuando sea apropiado para reducir las llamadas a la API
4. Versionado: Mantenga el seguimiento de los cambios de la API a través de nuestro registro de cambios