API Resumen

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

Autenticación

Todos los endpoints de API requieren autenticación. Para autenticar sus solicitudes, agregue su API clave en la x-api-key cabecera.

Ejemplo:

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

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

La authorization cabecera sigue siendo aceptada para claves de legado de API, pero x-api-key es la cabecera recomendada para todos los tipos de claves, incluidas las claves hash 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

Canal de dispositivo cambia utiliza el plugin API y tiene límites de prevención de abuso separados que se aplican a cada plan, incluyendo las pruebas.

• Un dispositivo puede realizar hasta 5 solicitudes por segundo para cada operación de canal (set, get, deleteo list). Este límite está escopificado 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. Cambiar a un canal diferente está permitido 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 en general. Si su cambiador de canal puede regresar a un canal seleccionado recientemente, espere al retryAfterSeconds tiempo 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 normalmente un data objeto o un status Respuestas de error incluyen un error Campo con una descripción de lo que salió mal.

Respuesta de ejemplo de éxito:

{
  "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, consumo de almacenamiento y banda ancha

Canales Control app update channels, bundles (versions), and update policies

Dispositivos Seguir y gestionar dispositivos que ejecutan tu aplicación, incluidas las asignaciones de conjunto (versión) y canal

Conjuntos Gestionar paquetes de aplicaciones, incluyendo subir, listar y administrar paquetes (versiones)

Consejos para una buena práctica

1. Manejo de ErroresSiempre compruebe las respuestas de error y maneje las mismas adecuadamente
2. Limitación de TasaImplemente el retraso exponencial al alcanzar los límites de velocidad
3. CachéCaché las respuestas cuando sea apropiado para reducir las llamadas a API.
4. VersiónSigue los cambios de API en nuestro registro de cambios

Sigue adelante desde la visión general de API

Si está utilizando API Visión general para planificar flujos de autenticación y cuentas, conecte con @capgo/capacitor-login-social para obtener detalles de implementación en @capgo/capacitor-login-social, @capgo/capacitor-clave de acceso para el detalle de implementación en @capgo/capacitor-passkey, @capgo/capacitor-nativo-biometrico para el detalle de implementación en @capgo/capacitor-native-biometric, Dos factores de autenticación para el detalle de implementación en Dos factores de autenticación, y SSO (Empresas) para el detalle de implementación en SSO (Empresas).