API Resumen

Esta es la documentación del recurso público API de Capgo en la nube de Cloudflare. El API permite gestionar de manera programática sus recursos Capgo, incluyendo organizaciones, dispositivos, canales y paquetes. Está diseñado para ser RESTful y utiliza métodos HTTP estándar.

Autenticación

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

Ejemplo:

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

Obtener API clave Genere su API clave en la consola de Capgo

Limitación de Tasa

La API implementa la limitación de tasa para garantizar un uso justo. Los límites actuales son:

• 100 solicitudes por minuto para cuentas estándar
• 1000 solicitudes por minuto para cuentas de empresa

Si superas estos límites, recibirás una respuesta 429 (Demasiadas solicitudes).

Formato de respuesta

Todas las respuestas están en formato JSON. Las respuestas exitosas suelen incluir ya sea un data objeto o un status campo. Las respuestas de error incluyen un error campo con una descripción de qué salió mal.

Respuesta de éxito de ejemplo:

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

Respuesta de error de ejemplo:

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

Puntos de conexión disponibles

Organizaciones Crear y gestionar organizaciones, actualizar configuraciones y manejar configuraciones de nivel de organización

API Claves Generar, listar y revocar API claves para acceso seguro a la Capgo API

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

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

Canales Controlar canales de actualización de la aplicación, conjuntos (versiones) y políticas de actualización

Dispositivos Administra y monitorea dispositivos que ejecutan tu aplicación, incluyendo la asignación de paquetes (versiones) y canales

Paquetes Administra paquetes de aplicaciones, incluyendo la carga, la lista y la gestión de paquetes (versiones)

Prácticas recomendadas

1. Gestión de erroresSiempre verifica respuestas de errores y maneja las respuestas de manera adecuada
2. Limitación de tasaImplementa el backoff exponencial cuando se superen los límites de tasa
3. CachéAlmacena respuestas cuando sea apropiado para reducir llamadas a API
4. Versión: Mantenga un registro de los cambios de API a través de nuestro changelog