API Resumen

This is the documentation of the public API of Capgo cloud. The API allows you to programmatically manage your Capgo resources, including organizations, devices, channels, and bundles. It’s designed to be RESTful and uses standard HTTP methods.

Autenticación

All API endpoints require authentication. To authenticate your requests, add your API key in the x-api-key encabezado.

Ejemplo:

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

Get API key Generate your API key in the Capgo dashboard

El authorization header is still accepted for legacy API keys, but x-api-key es la cabecera recomendada para todos los tipos de clave, incluidas las claves hash seguras.

Limitación de Tasa

El 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 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, deleteo list. Esta limitación está scoped a la aplicación, el dispositivo y la operación.
• Al configurar el mismo dispositivo en el mismo canal más de una vez dentro de 60 segundos se 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.

Estas limitaciones no son de cuenta en general. Si su cambiador de canal puede regresar a un canal seleccionado recientemente, espere al retryAfterSeconds duración en la respuesta 429 antes de intentarlo de nuevo.

Formato de respuesta

Todas las respuestas están en formato JSON. Las respuestas exitosas suelen incluir ya sea un data o un status La respuesta de error incluye un error con una descripción de qué 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 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 Acceda a análisis detallados sobre el uso de la aplicación, almacenamiento y consumo de ancho de banda

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

Dispositivos Administre dispositivos que ejecutan su aplicación, incluidas las asignaciones de paquete (versión) y canal

Paquetes Gestione paquetes de la aplicación, incluida la carga, lista y gestión de paquetes (versiones)

Consejos para una mejor práctica

1. Siempre compruebe las respuestas de error y maneje las mismas de manera adecuadaLímite de tasa
2. Rate Limiting: Implementa el retraso exponencial cuando se superen los límites de velocidad
3. Caching: Almacena respuestas cuando sea apropiado para reducir las llamadas a API
4. Versión: Mantén un registro de los cambios de API a través de nuestro changelog

Sigue adelante desde la API Vista general

Si estás utilizando API Vista general para planificar flujos de autenticación y cuentas, conecta con @capgo/capacitor-login-social para obtener los detalles de implementación en @capgo/capacitor-login-social, @capgo/capacitor-passkey para los detalles de implementación en @capgo/capacitor-passkey @capgo/capacitor-native-biometric para los detalles de implementación en @capgo/capacitor-native-biometric Autenticación de dos factores para los detalles de implementación en la autenticación de dos factores, y SSO (Empresas) para los detalles de implementación en SSO (Empresas).