API Resumen

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

Autenticación

Todos los API endpoints requieren autenticación. Para autenticar tus solicitudes, agrega tu API clave en el x-api-key encabezado.

Ejemplo:

curl -H "x-api-key: YOUR_API_KEY" https://api.capgo.app/organization/

Obtén API clave Genera tu API clave en la consola de Capgo

El authorization encabezado sigue siendo aceptado para claves de API legado, pero x-api-key es el encabezado recomendado para todos los tipos de claves, incluidas las claves hashadas seguras.

Limitación de tasa

La API implementa limitaciones 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 de empresa

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

Cambios de canal de dispositivo

Los cambios de canal de dispositivo utilizan el plugin API y tienen límites de prevención de abuso separados que se aplican a cada plan, incluidas las pruebas:

• Un dispositivo puede realizar hasta 5 solicitudes por segundo para cada operación de canal (set, get, delete, o list). Este límite está escopado a la aplicación, el dispositivo y la operación.
• Establecer el mismo dispositivo en el mismo canal más de una vez dentro de 60 segundos devuelve una respuesta 429. Se permite cambiar a un canal diferente después de que se resetea el límite por segundo.
• Se aplica un límite adicional de 1000 solicitudes de canal por minuto a cada aplicación y dirección IP.

Estos límites no son de cuenta. Si su selector de canal puede regresar a un canal seleccionado recientemente, espere al retryAfterSeconds duración en la respuesta 429 antes de volver a intentarlo.

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.

Ejemplo de respuesta exitosa:

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

Ejemplo de respuesta de error:

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

Endpoints Disponibles

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

API Claves Generar, listar y revocar claves API 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 asignaciones de paquete (versión) y canal

Packages Gestiona paquetes de la aplicación, incluyendo subir, listar y administrar paquetes (versiones)

Prácticas recomendadas

1. Manejo de erroresSiempre verifica respuestas de error y maneja las mismas de manera adecuada
2. Límites de tasaImplementa un backoff exponencial cuando se alcancen los límites de tasa
3. CachingCaching respuestas cuando sea apropiado para reducir API llamadas
4. VersiónSeguir el historial de cambios de API a través de nuestro changelog

Seguir desde API Resumen

Si estás utilizando API Resumen para planificar flujos de autenticación y cuentas, conecta con @capgo/capacitor-login-social para obtener detalles de implementación en @capgo/capacitor-login-social, @capgo/capacitor-clave-privada para obtener detalles de implementación en @capgo/capacitor-clave-privada, @capgo/capacitor-autenticación-nativa para el detalle de implementación en @capgo/capacitor-biometría nativa, Autenticación de dos factores para el detalle de implementación en Autenticación de dos factores, y SSO (Empresas) para el detalle de implementación en SSO (Empresas).