Resumen de API

Esta es la documentación del API público de Capgo en la nube. El API 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 puntos finales requieren autenticación. Para autenticar sus solicitudes, agregue su API clave en el x-api-key cabecera

Ejemplo:

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

Obtener la clave API Genera tu clave API en la consola de Capgo

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

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 (Demasiados 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.

Ejemplo de respuesta exitosa:

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

Ejemplo de respuesta de error:

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

Puntos de conexión disponibles

Organizaciones Crear y administrar 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 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 canales de actualización de la aplicación, conjuntos (versiones) y políticas de actualización

Dispositivos Administra y gestiona dispositivos que ejecutan tu aplicación, incluyendo asignaciones de paquete (versión) y canal

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

Consejos para un buen uso

1. Gestión de Errores: Siempre verifica respuestas de error y gestiona las mismas de manera adecuada
2. Limitación de Tasa: Implementa backoff exponencial cuando se alcancen límites de tasa
3. Caché: Almacena respuestas cuando sea apropiado para reducir API llamadas
4. VersiónRegistra los cambios de API a través de nuestro registro de cambios

Sigue desde API Resumen

Si estás utilizando API Resumen para planificar flujos de autenticación y cuentas, conecta con @capgo/capacitor-login-social para los detalles de implementación en @capgo/capacitor-login-social, @capgo/capacitor-clave-privada para los detalles de implementación en @capgo/capacitor-clave-privada, @capgo/capacitor-autenticación-nativa para el detalle de implementación en @capgo/capacitor-biométrico nativo, 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).