Panoramica
L’API Online Booking collega il motore di prenotazione del sito web dell’hotel a HMS Gestionale Alberghiero. Elenchi di camere e tariffe, disponibilità a calendario, convalida dei coupon, fase di pagamento e invio della prenotazione a HMS passano tutti da questa API. È pensata per le agenzie che sviluppano motori di prenotazione e per i partner di HMS.
URL di base#
Tutti gli endpoint si trovano sotto l’URL di base riportato qui sotto, nel percorso /external/…. È accettato solo HTTPS.
https://test.hms.gen.trIl flusso in sintesi#
POST /external/public/loginPOST /external/online/roomTypePOST …/payment/type/{type}POST …/channel/bookingIl token ottenuto con il login è valido 7 giorni ed è legato a un solo hotel. L’elenco camere restituisce le camere vendibili e i prezzi per le date e l’occupazione cercate dall’ospite; dopo la scelta dell’ospite e la definizione del tipo di pagamento, la prenotazione viene scritta in HMS come BookingPushRQ. La guida Flusso di prenotazione illustra ogni passaggio.
Risorse#
| Risorsa | Endpoint |
|---|---|
| Autenticazione | POST /external/public/login |
| Camere e tariffe | POST /external/online/roomTypeGET /external/room/type/hotel/availability |
| Prenotazione | POST /external/online/channel/booking |
| Pagamento | GET /external/online/payment/typeGET /external/payment/companyPOST /external/online/payment/type/{paymentType} |
| Coupon | POST /external/online/coupon/search |
| Pacchetti ed extra | GET /external/stock/packages |
| Informazioni sull’hotel | GET /external/hotel/{hotelID}/contact/infoGET /external/online/social/mediaGET /external/online/footerGET /external/online/mail/host |
| Tabelle di riferimento | POST /external/countiesGET /external/currenciesGET /external/languages |
Regole generali#
- Tutte le richieste, tranne il login, includono l’header
Authorization: Bearer <token>. - La maggior parte degli endpoint
POSTaccetta campi form (application/x-www-form-urlencodedomultipart/form-data). L’invio della prenotazione e l’avvio del pagamento richiedono un corpo JSON. La pagina di riferimento di ogni endpoint indica quale formato usare. - Le risposte sono in JSON e contengono un flag
success. Anche gli errori di logica applicativa tornano come HTTP200: valuta l’esito in base asuccess, non al codice di stato. - Le date sono nel formato
YYYY-MM-DD, gli importi sono stringhe con due decimali ("965.00") e la valuta deriva dalle impostazioni del canale online dell’hotel. - Il parametro
hotelIDdeve corrispondere all’hotel a cui è legato il token.
Versione#
Questa documentazione riguarda la V2 dell’API HMS. Nuovi campi ed endpoint possono essere aggiunti senza preavviso: scrivi il tuo client in modo che ignori i campi sconosciuti. Le modifiche sono elencate nelle note di rilascio.