Overzicht
De Online Booking API koppelt de boekingsmodule op de eigen website van een hotel aan HMS Hotelsoftware. Kamer- en tarievenlijsten, de beschikbaarheidskalender, het valideren van kortingscodes, de betaalstap en het doorsturen van de boeking naar HMS lopen allemaal via deze API. De API is bedoeld voor bureaus die boekingsmodules bouwen en voor partners van HMS.
Basis-URL#
Alle endpoints staan onder de onderstaande basis-URL, op het pad /external/…. Alleen HTTPS wordt geaccepteerd.
https://test.hms.gen.trDe flow in het kort#
POST /external/public/loginPOST /external/online/roomTypePOST …/payment/type/{type}POST …/channel/bookingHet token uit de login is 7 dagen geldig en gebonden aan één hotel. De kamerlijst geeft de verkoopbare kamers en prijzen terug voor de datums en bezetting waarop de gast heeft gezocht; zodra de gast heeft gekozen en de betaalmethode rond is, wordt de boeking als BookingPushRQ in HMS vastgelegd. De handleiding Boekingsflow loopt elke stap door.
Resources#
| Resource | Endpoints |
|---|---|
| Authenticatie | POST /external/public/login |
| Kamers en tarieven | POST /external/online/roomTypeGET /external/room/type/hotel/availability |
| Boeking | POST /external/online/channel/booking |
| Betaling | GET /external/online/payment/typeGET /external/payment/companyPOST /external/online/payment/type/{paymentType} |
| Kortingscode | POST /external/online/coupon/search |
| Pakketten en extra’s | GET /external/stock/packages |
| Hotelinformatie | GET /external/hotel/{hotelID}/contact/infoGET /external/online/social/mediaGET /external/online/footerGET /external/online/mail/host |
| Keuzelijsten | POST /external/countiesGET /external/currenciesGET /external/languages |
Algemene regels#
- Elk verzoek behalve de login bevat een header
Authorization: Bearer <token>. - De meeste
POST-endpoints verwachten formuliervelden (application/x-www-form-urlencodedofmultipart/form-data). Het doorsturen van de boeking en het starten van de betaling verwachten een JSON-body. Op de referentiepagina van elk endpoint staat welke van de twee geldt. - Antwoorden zijn JSON met een
success-veld. Fouten in de bedrijfslogica komen ook terug als HTTP200; beoordeel de uitkomst opsuccess, niet op de statuscode. - Datums hebben de vorm
YYYY-MM-DD, bedragen zijn strings met twee decimalen ("965.00") en de valuta komt uit de instellingen van het online kanaal van het hotel. - De parameter
hotelIDmoet overeenkomen met het hotel waaraan het token gebonden is.
Versie#
Deze documentatie beschrijft HMS API V2. Nieuwe velden en endpoints kunnen zonder aankondiging worden toegevoegd; schrijf je client zo dat onbekende velden worden genegeerd. Wijzigingen staan in de releasenotes.