API Resumen

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

Autenticación

Todas las API peticiones requieren autenticación. Para autenticar tus solicitudes, agrega tu API clave en el x-api-key cabecera.

Ejemplo:

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

Obtener API clave Genera tu API clave en el Capgo dashboard

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

Límite de Tasa

El API implementa límites 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 supera estos límites, recibirá 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 campo. Las respuestas de error incluyen un campo con una descripción de qué salió mal. status un campo con una descripción de qué salió mal. error Ejemplo de respuesta de éxito:

Copiar a portapapeles

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

Copiar a portapapeles

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

Sección titulada “Endpoints disponibles”

Crear y administrar organizaciones, actualizar configuraciones y manejar configuraciones a nivel de organización __CAPGO_KEEP_0__ Claves

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

Miembros Administrar 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 los canales de actualización de la aplicación, paquetes (versiones) y políticas de actualización

Dispositivos Seguir y administrar dispositivos que ejecutan la aplicación, incluyendo asignaciones de paquete (versión) y canal

Paquetes Gestionar paquetes de la aplicación, incluyendo subir, listar y gestionar paquetes (versiones)

Prácticas recomendadas

1. Manejo de errores: Siempre compruebe las respuestas de error y maneje las mismas de manera adecuada
2. Limitación de tasa: Implemente un backoff exponencial cuando se alcancen los límites de tasa
3. Caché: Cache las respuestas cuando sea apropiado para reducir API llamadas
4. Versionado: Mantenga un registro de los cambios de API a través de nuestro changelog

Sigue adelante desde API Resumen

Si está utilizando API Resumen para planificar la autenticación y los flujos de cuenta, conectarlo con @capgo/capacitor-iniciode sesión social para los detalles de implementación en @capgo/capacitor-iniciode sesión social, @capgo/capacitor-clave de acceso para los detalles de implementación en @capgo/capacitor-clave de acceso, @capgo/capacitor-autenticación biométrica nativa para los detalles de implementación en @capgo/capacitor-autenticación biométrica nativa, Autenticación de dos factores para los detalles de implementación en Autenticación de dos factores, y SSO (Empresas) para los detalles de implementación en SSO (Empresas).