Smart Travel X: Endpoints
Descripción General
Este documento describe los estándares utilizados para establecer la conectividad entre el sistema del cliente y Smart Travel X.
Para lograr esta conectividad, el cliente debe proporcionar una API que consta de todos los endpoints que permiten a Smart Travel X consultar y actualizar toda la información correspondiente. Todos estos endpoints del lado del del cliente deben implementarse para una integración exitosa.
El sistema también incluye algunos endpoints proporcionados por Smart Travel X, que el cliente deberá utilizar para actualizar la información sobre las reservas, disponibilidad, entre otras y además de poder consultar información de Smart Travel X.
Formato de la API
La API debe implementarse como un conjunto de endpoints HTTPS que manejan datos en formato JSON. Es importante que el encabezado HTTP Content-type esté configurado en application/json para todas las respuestas.
Tenga en cuenta que podremos agregar nuevos campos en la API a nuestra conveniencia, esto con el fin de implementar mejoras y nuevas funcionalidades.
Autenticación
La autenticación de API en ambas direcciones (desde Smart Travel X a su sistema de API y desde su sistema a la API de Smart Travel X) se logra mediante la autenticación de acceso básica de HTTP. Es decir, el nombre de usuario y la contraseña se proporcionan en el campo de encabezado de Autorización de acuerdo con la especificación HTTP.
| Tipo de Seguridad | HTTP |
|---|---|
| Esquema de Autorización HTTP | Básico |
No se permiten otras formas de autenticación (p. ej., no se aceptan OAuth ni tokens).
Credenciales de Acceso:
Smart Travel X le proporcionará las credenciales de acceso que se deberán implementar en una comunicación bidireccional, es decir, tanto para comunicarse desde Smart Travel X a su sistema API y desde su sistema API a Smart Travel X.
Las credenciales definirán el acceso a la API completa y no es posible proporcionar un nombre de usuario y una contraseña diferentes en función de los clientes alojados en su sistema.
Observaciones: Todos los endpoints del lado del Cliente deberán ser creados y deberán devolver la respuesta esperada, en caso contrario Smart Travel X seguirá enviando el mensaje cada minuto hasta que se procese de forma correcta.