Огляд
Online Booking API підключає модуль бронювання на власному сайті готелю до готельної програми HMS. Через цей API проходять списки номерів і цін, наявність у календарі, перевірка купонів, крок оплати й передавання бронювання в HMS. Він призначений для агенцій, які розробляють модулі бронювання, і для партнерів HMS.
Базова URL-адреса#
Усі ендпоінти розміщено за базовою URL-адресою нижче, у шляху /external/…. Приймаються лише запити через HTTPS.
https://test.hms.gen.trПроцес коротко#
POST /external/public/loginPOST /external/online/roomTypePOST …/payment/type/{type}POST …/channel/bookingТокен, отриманий під час входу, дійсний 7 днів і прив’язаний до одного готелю. Список номерів повертає доступні для продажу номери й ціни на дати та кількість гостей, які шукав гість; коли гість зробив вибір і тип оплати визначено, бронювання записується в HMS як BookingPushRQ. Кожен крок докладно описано в посібнику Процес бронювання.
Ресурси#
| Ресурс | Ендпоінти |
|---|---|
| Автентифікація | POST /external/public/login |
| Номери й ціни | POST /external/online/roomTypeGET /external/room/type/hotel/availability |
| Бронювання | POST /external/online/channel/booking |
| Оплата | GET /external/online/payment/typeGET /external/payment/companyPOST /external/online/payment/type/{paymentType} |
| Купон | POST /external/online/coupon/search |
| Пакети й додаткові послуги | GET /external/stock/packages |
| Інформація про готель | GET /external/hotel/{hotelID}/contact/infoGET /external/online/social/mediaGET /external/online/footerGET /external/online/mail/host |
| Довідники | POST /external/countiesGET /external/currenciesGET /external/languages |
Загальні правила#
- Кожен запит, крім входу, містить заголовок
Authorization: Bearer <token>. - Більшість ендпоінтів
POSTприймають поля форми (application/x-www-form-urlencodedабоmultipart/form-data). Передавання бронювання й запуск оплати очікують тіло у форматі JSON. Який формат потрібен, указано на сторінці кожного ендпоінта в довіднику. - Відповіді надходять у форматі JSON із полем
success. Помилки бізнес-правил теж повертаються з HTTP200, тож оцінюйте результат заsuccess, а не за кодом стану. - Дати мають формат
YYYY-MM-DD, суми — рядки з двома знаками після крапки ("965.00"), а валюта береться з налаштувань онлайн-каналу готелю. - Параметр
hotelIDмає збігатися з готелем, до якого прив’язаний токен.
Версія#
Ця документація описує HMS API V2. Нові поля й ендпоінти можуть з’являтися без попередження, тому пишіть клієнт так, щоб він ігнорував невідомі поля. Зміни наведено в журналі змін.