Überblick
Die Online Booking API verbindet die Buchungsmaschine auf der eigenen Website eines Hotels mit der HMS Hotelsoftware. Zimmer- und Preislisten, Verfügbarkeitskalender, Gutscheinprüfung, Zahlungsschritt und die Übermittlung der Buchung an HMS laufen über diese API. Sie richtet sich an Agenturen, die Buchungsmaschinen entwickeln, und an HMS-Partner.
Basis-URL#
Alle Endpunkte liegen unter der folgenden Basis-URL im Pfad /external/…. Es wird ausschließlich HTTPS akzeptiert.
https://test.hms.gen.trAblauf im Überblick#
POST /external/public/loginPOST /external/online/roomTypePOST …/payment/type/{type}POST …/channel/bookingDas Token aus der Anmeldung ist 7 Tage gültig und an ein Hotel gebunden. Die Zimmerliste liefert die verkaufbaren Zimmer und Preise für den Zeitraum und die Belegung, nach denen der Gast gesucht hat; sobald der Gast gewählt hat und die Zahlungsart feststeht, wird die Buchung als BookingPushRQ in HMS geschrieben. Der Leitfaden Buchungsablauf beschreibt jeden Schritt.
Ressourcen#
| Ressource | Endpunkte |
|---|---|
| Authentifizierung | POST /external/public/login |
| Zimmer und Preise | POST /external/online/roomTypeGET /external/room/type/hotel/availability |
| Buchung | POST /external/online/channel/booking |
| Zahlung | GET /external/online/payment/typeGET /external/payment/companyPOST /external/online/payment/type/{paymentType} |
| Gutschein | POST /external/online/coupon/search |
| Pakete und Extras | GET /external/stock/packages |
| Hotelinformationen | GET /external/hotel/{hotelID}/contact/infoGET /external/online/social/mediaGET /external/online/footerGET /external/online/mail/host |
| Stammdaten | POST /external/countiesGET /external/currenciesGET /external/languages |
Allgemeine Regeln#
- Jede Anfrage außer der Anmeldung enthält einen
Authorization: Bearer <token>-Header. - Die meisten
POST-Endpunkte erwarten Formularfelder (application/x-www-form-urlencodedodermultipart/form-data). Die Buchungsübermittlung und der Start der Zahlung erwarten JSON-Bodys. Die Referenzseite jedes Endpunkts gibt an, welches Format gilt. - Antworten sind JSON mit einem
success-Flag. Auch Fehler aus Geschäftsregeln kommen als HTTP200zurück; beurteilen Sie das Ergebnis anhand vonsuccess, nicht anhand des Statuscodes. - Datumsangaben haben das Format
YYYY-MM-DD, Beträge sind Strings mit zwei Nachkommastellen ("965.00"), und die Währung stammt aus den Einstellungen des Online-Kanals des Hotels. - Der Parameter
hotelIDmuss mit dem Hotel übereinstimmen, an das das Token gebunden ist.
Version#
Diese Dokumentation beschreibt HMS API V2. Neue Felder und Endpunkte können ohne Ankündigung hinzukommen; schreiben Sie Ihren Client so, dass er unbekannte Felder ignoriert. Änderungen sind in den Versionshinweisen aufgeführt.