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. Conoce más sobre la API que impulsa Compass.
Descripción general y formato
La Compass La API proporciona acceso seguro a las preferencias, el estado de la conversación y las experiencias y habilidades de los usuarios, 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 cargas 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: se puede solicitar una clave de API 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 tener el formato: x-api-key: <your-access-token>.
Encabezados de autorización: son específicos del usuario de Compass y requieren iniciar sesión primero en la aplicación Compass para obtener el token de acceso.
Acceso directo a la especificación OpenAPI
Existen dos métodos de acceso para las especificaciones de la API. El método principal es a través de la página interactiva de documentación de Swagger UI, que permite explorar y probar en vivo todos los endpoints. Es importante destacar que, para los desarrolladores que desean configurar rápidamente sus clientes, se proporciona un enlace directo e independiente al archivo de especificación JSON de OpenAPI v3. Este enlace es esencial para los desarrolladores que quieren importar toda la definición de la API en herramientas como Postman o Insomnia (usando el opción Importar > Enlace), acelerando la configuración mediante la generación automática de 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 velocidad
Para garantizar un acceso justo y estable para todos los usuarios, aplicamos una política de limitación de velocidad. Los desarrolladores están limitados a 120 solicitudes por minuto por cada clave de API única. Superar este umbral provocará inmediatamente la devolución de un código de estado HTTP 429 "Demasiadas solicitudes", y las solicitudes posteriores se bloquearán hasta que se reinicie el minuto.
Última actualización