Descripción general
La API de Online Booking conecta el motor de reservas del propio sitio web del hotel con HMS Software Hotelero. Las listas de habitaciones y tarifas, la disponibilidad en calendario, la validación de cupones, el paso de pago y el envío de la reserva a HMS pasan por esta API. Está pensada para las agencias que desarrollan motores de reservas y para los partners de HMS.
URL base#
Todos los endpoints están bajo la URL base siguiente, en la ruta /external/…. Solo se acepta HTTPS.
https://test.hms.gen.trEl flujo de un vistazo#
POST /external/public/loginPOST /external/online/roomTypePOST …/payment/type/{type}POST …/channel/bookingEl token del inicio de sesión es válido durante 7 días y está vinculado a un solo hotel. La lista de habitaciones devuelve las habitaciones a la venta y sus precios para las fechas y la ocupación que buscó el huésped; cuando el huésped ha elegido y el tipo de pago está resuelto, la reserva se registra en HMS como un BookingPushRQ. La guía Flujo de reserva recorre cada paso.
Recursos#
| Recurso | Endpoints |
|---|---|
| Autenticación | POST /external/public/login |
| Habitaciones y tarifas | POST /external/online/roomTypeGET /external/room/type/hotel/availability |
| Reserva | POST /external/online/channel/booking |
| Pago | GET /external/online/payment/typeGET /external/payment/companyPOST /external/online/payment/type/{paymentType} |
| Cupón | POST /external/online/coupon/search |
| Paquetes y extras | GET /external/stock/packages |
| Información del hotel | GET /external/hotel/{hotelID}/contact/infoGET /external/online/social/mediaGET /external/online/footerGET /external/online/mail/host |
| Catálogos | POST /external/countiesGET /external/currenciesGET /external/languages |
Reglas generales#
- Todas las solicitudes, excepto la de inicio de sesión, llevan un encabezado
Authorization: Bearer <token>. - La mayoría de los endpoints
POSTreciben campos de formulario (application/x-www-form-urlencodedomultipart/form-data). El envío de reservas y el inicio del pago esperan cuerpos JSON. La página de referencia de cada endpoint indica cuál usa. - Las respuestas son JSON con un indicador
success. Los errores de reglas de negocio también se devuelven como HTTP200; evalúa el resultado porsuccess, no por el código de estado. - Las fechas tienen el formato
YYYY-MM-DD, los importes son cadenas con dos decimales ("965.00") y la moneda procede de la configuración del canal online del hotel. - El parámetro
hotelIDdebe coincidir con el hotel al que está vinculado el token.
Versión#
Esta documentación cubre la API de HMS V2. Se pueden añadir campos y endpoints nuevos sin previo aviso; programa tu cliente para que ignore los campos desconocidos. Los cambios se publican en el registro de cambios.