Online Booking API
Connects the hotel website’s booking engine to HMS: room and rate list, calendar availability, coupons, payment and booking push.
- Base URL
https://test.hms.gen.tr- Authentication
- apiKey / apiSecret → Bearer token
- Format
- JSON responses · form or JSON request bodies
- Scope
- 8 resources · 16 endpoints
Resources#
Authentication
1 endpointsAccess to the Online Booking API uses partner credentials issued by HMS. The login endpoint exchanges apiKey and apiSecret for a token, which is sent …
- POST
/external/public/login
Rooms and rates
2 endpointsTwo endpoints that power the booking engine’s search results: the room list, which returns sellable room types, board types and prices for the given d…
- POST
/external/online/roomType - GET
/external/room/type/hotel/availability
Booking
1 endpointsThe room, board type and rate the guest selected are pushed to HMS in a BookingPushRQ structure. The same endpoint handles cancellations and modificat…
- POST
/external/online/channel/booking
Payment
3 endpointsLists the payment types the hotel accepts for online bookings and starts the payment step for the selected type. What to do for each type is described…
- GET
/external/online/payment/type - GET
/external/payment/company - POST
/external/online/payment/type/{paymentType}
Coupon
1 endpointsValidates the online discount coupons the hotel defined in the panel. Apply the discount on your side and send the discounted amounts in the booking p…
- POST
/external/online/coupon/search
Packages and extras
1 endpointsExtras that can be sold with a booking: room packages (tied to a room type) and general packages (transfer, dinner, spa). Sold packages are sent in th…
- GET
/external/stock/packages
Hotel information
4 endpointsData that fills the booking engine’s page chrome: contact details and location, social media links, footer texts (legal, about, analytics/ads snippets…
- GET
/external/hotel/{hotelID}/contact/info - GET
/external/online/social/media - GET
/external/online/footer - +1 more
Lookups
3 endpointsStatic lists for form options: countries, currencies and languages. They rarely change and can be cached for a day.
- POST
/external/counties - GET
/external/currencies - GET
/external/languages
Documentation#
Getting started
- OverviewWhat the Online Booking API does, base URL, flow summary and general rules.
- QuickstartGet a token with your partner credentials and send your first room and rate query.
- AuthenticationLogin with apiKey / apiSecret, Bearer token, hotel context and token lifetime.
- Requests and responsesForm and JSON bodies, the success envelope, pagination, date and amount formats, HTTP status codes.
- Error codesmessage and errorCode values, authentication errors and retry guidance.