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 a Compass.
Última actualización
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 a Compass.
El Compass API proporciona acceso seguro a las preferencias de los usuarios, al estado de la conversación y a las experiencias y habilidades, permitiendo 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 asegurar una comunicación estandarizada, todas las solicitudes y respuestas (excepto las cargas de archivos) utilizan el formato JSON, lo que facilita la integración con cualquier entorno de programación moderno.
Antes de la integración, los desarrolladores deben obtener las credenciales necesarias.
Claves de API: Una clave de API puede solicitarse contactando a los administradores vía el 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: <tu-token-de-acceso>.
Encabezados de autorización: Estos son específicos del usuario de Compass y requieren primero iniciar sesión a través de la aplicación Compass para obtener el token de acceso.
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 navegar y probar en vivo todos los endpoints. De forma crucial, para los desarrolladores que buscan 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 desean 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
Para garantizar un acceso justo y estable para todos los usuarios, aplicamos una política de limitación de tasa. Los desarrolladores están limitados a 120 solicitudes por minuto por cada clave de API única. Superar este umbral resultará inmediatamente en la devolución de un código de estado HTTP 429 "Demasiadas solicitudes", y las solicitudes posteriores serán bloqueadas hasta que se restablezca el minuto.
Última actualización