API de Compass

Compass es un chatbot innovador impulsado por IA diseñado para revolucionar la forma en que una persona joven identifica, articula y muestra sus habilidades. Conozca más sobre la API que impulsa Compass.

Resumen y formato

El Brújula La API proporciona acceso seguro a las preferencias de los usuarios, al estado de la conversación y a las experiencias y habilidades, lo que permite una integración fluida con sus aplicaciones. La URL base para todas las solicitudes de la API es https://demo.compass.tabiya.tech/api/docs. Para garantizar una comunicación estandarizada, todas las solicitudes y respuestas (excepto las subidas de archivos) utilizan el formato JSON, lo que facilita la integración con cualquier entorno de programación moderno.

Credenciales y autenticación

Antes de la integración, los desarrolladores deben obtener las credenciales necesarias.

• Claves de API: Una clave de API se puede solicitar contactando a los administradores a través del correo electrónico designado. Una vez emitida, la clave de API debe incluirse en el encabezado x-api-key de cada solicitud. Por ejemplo, el encabezado debe formatearse como: x-api-key: <your-access-token>.

• Encabezados de autorización: Estos son específicos del usuario de Compass y requieren iniciar sesión primero a través de la aplicación Compass para obtener el token de acceso.

Acceso directo a la especificación OpenAPI

Hay dos métodos de acceso disponibles para las especificaciones de la API. El método principal es a través de la página de documentación interactiva Swagger UI, que permite explorar y probar en vivo todos los endpoints. De forma crucial, para los desarrolladores que desean configurar rápidamente sus clientes, se proporciona un enlace directo y autónomo al archivo de especificación JSON OpenAPI v3. Este enlace es esencial para los desarrolladores que quieran importar toda la definición de la API en herramientas como Postman o Insomnia (usando el opción Importar > Enlace), acelerando la configuración al generar automáticamente todas las definiciones de endpoints, parámetros y esquemas:

• Enlace de la especificación OpenAPI: https://demo.compass.tabiya.tech/openapi.json

• Enlace de Swagger: https://demo.compass.tabiya.tech/api/docs

Políticas de uso y limitación de tasas

Para garantizar un acceso justo y estable para todos los usuarios, aplicamos una política de limitación de tasas. Los desarrolladores están limitados a 120 solicitudes por minuto por clave de API única. Superar este umbral resultará inmediatamente en un código de estado HTTP 429 "Too Many Requests" y las solicitudes posteriores serán bloqueadas hasta que se restablezca el minuto.