API Resumen

Esta es la documentación del API público de Capgo en la nube. El API te permite gestionar de manera 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

Todos los puntos finales de API requieren autenticación. Para autenticar tus solicitudes, agrega tu 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 Genera tu API clave en la consola de Capgo

La authorization cabecera sigue siendo aceptada para claves API legadas x-api-key es la cabecera recomendada para todos los tipos de clave, incluidas las claves hashadas de seguridad.

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 superas estos límites, recibirás 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. Esta limitación está escopada al aplicación, dispositivo y 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 para cada aplicación y dirección IP.

Estas limitaciones no son de cuenta en su totalidad. Si su cambiador 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 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 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 Acceda a análisis detallados sobre el uso de la aplicación, almacenamiento y consumo de ancho de banda

Canales context

Nombre de característica de canales de Capgo. Página/área: Página de marketing de soluciones de Capgo. Rol: Etiqueta de IU breve o elemento de navegación. Visto en: página solutions/white-label.astro. Clave de mensaje `solutions_white_label_visual_cell2_value` (Valor de celda visual de soluciones White Label). Controlar los canales de actualización de la aplicación, los conjuntos (versiones) y las políticas de actualización

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

Conjuntos

1. Prácticas recomendadasTítulo de sección “Prácticas recomendadas”
2. Manejo de errores: Siempre compruebe las respuestas de error y maneje las mismas de manera adecuada: Implemento un retraso exponencial cuando se superen los límites de velocidad
3. Caching: Cachear respuestas cuando sea apropiado para reducir llamadas a API
4. Versión: Mantenga un registro de los cambios de API a través de nuestro changelog

Siga desde API Resumen

Si está utilizando API Resumen para planificar la autenticación y los flujos de cuenta, conecte con capgo/capacitor-login-social para los detalles de implementación en capgo/capacitor-login-social, @capgo/capacitor-passkey para el detalle de implementación en @capgo/capacitor-passkey @capgo/capacitor-native-biometric para el detalle de implementación en @capgo/capacitor-native-biometric Autenticación en dos factores para el detalle de implementación en la autenticación en dos factores, y SSO (Empresas) para el detalle de implementación en SSO (Empresas).