Cerca in:
Cerca in:

Documentazione per l’integrazione del modulo Hotel Proxima tramite API

Il modulo Hotel di Proxima fornisce un set di API che consente al PMS di interagire con esso sfruttando la logica del protocollo FIAS. 
Questo set di API permette di sincronizzare eventi e informazioni gestite dal PMS con il modulo Hotel e viceversa, in base all’autorità del sistema. 

Le API del modulo Hotel sono progettate per due scopi principali

  • Ricezione di eventi dal PMS per cui il PMS è autoritativo.
  • Notifica degli eventi al PMS per cui il modulo Hotel di Proxima è autoritativo, tramite Web API.

API Esposte dal Modulo Hotel di Proxima

Le seguenti API permettono al PMS di interagire con il modulo Hotel per gestire eventi come Check-in, Check-out, sveglie, e configurazioni delle camere:

  • Check-in
    • Endpoint: POST /api/v2/hotel/check-in
    • Descrizione: Richiede il check-in di una camera. L’operazione è immediata; la data di arrivo e partenza sono solo informazioni visuali.
  • Check-out
    • Endpoint: POST /api/v2/hotel/check-out
    • Descrizione: Richiede il check-out di una camera. L’operazione è immediata; la data di partenza è solo un’informazione visuale.
  • Richiesta Sveglia
    • Endpoint: POST /api/v2/hotel/wakeup-request
    • Descrizione: Richiede la creazione di una sveglia per una camera. All’ora specificata, il PBX invierà la sveglia alla camera.
  • Cancellazione Sveglia
    • Endpoint: POST /api/v2/hotel/wakeup-cancel
    • Descrizione: Richiede la cancellazione di una sveglia per una camera. Il sistema cercherà la sveglia all’ora specificata e la cancellerà se presente.
  • Configurazione dei Servizi Camera
    • Endpoint: POST /api/v2/hotel/room-equipment
    • Descrizione: Richiede la modifica della configurazione dei servizi della camera (es. classi di servizio, DND – Do Not Disturb).

Autenticazione

  • Metodo: Basic Auth
  • Dettagli: Si utilizza un unico utente del gruppo interop (per singolo tenant) su Proxima.

I partner certificati potranno richiedere il progetto Postman con tutti i dettagli delle API.

Eventi Notificabili da Proxima al PMS

Il modulo Hotel può notificare al PMS una serie di eventi tramite le WebAPI esposte dal sistema del PMS.
Tali notifiche possono essere ritardate di circa 15 secondi e sono stateless, quindi si consiglia di utilizzare metodi di autenticazione con valori statici.

Gli eventi configurabili sono:

  • Billing: Minibar
  • Billing: Telefonata
  • DND (Do Not Disturb): On/Off
  • Stato della Camera
  • Sveglia: Nuova, Cancellata, Stato

Configurazione Notifiche nel Pannello Admin

Nel pannello di amministrazione del modulo Hotel (sezione API), è possibile configurare la notifica degli eventi, specificando:

  • URL richiesta: Es. https://erp.customer.com/api/dnd-on
  • Metodo di autenticazione: Basic, Digest o disattivata (eventualmente si può usare Bearer Authentication con gli header).
  • Username e Password: Credenziali per l’autenticazione.
  • Metodo di richiesta: POST, GET, PUT, DELETE.
  • Headers della richiesta: Es. Content-Type: application/json
  • Body della richiesta: Corpo del messaggio della richiesta.

Variabili Disponibili per le Notifiche

Le seguenti variabili sono disponibili per personalizzare le notifiche, sia nell’URL della richiesta che nel corpo del messaggio:

Globali:

  • Numero camera: {$replace_room_number}
  • Data evento (Y-m-d): {$replace_date}
  • Orario evento (H:i:s): {$replace_time}
  • Data e ora evento (Epoch): {$replace_datetime_epoch}
  • Data e ora evento (ISO 8601): {$replace_datetime_iso_8601}
  • Data e ora evento (RFC 5322): {$replace_datetime_rfc_5322}
  • Data e ora evento (Y-m-d H:i:s): {$replace_datetime}

Billing – Minibar:

  • ID accredito: {$replace_booking_extra_id}
  • Codice articolo minibar: {$replace_minibar_code}

Billing – Telefonata:

  • ID accredito: {$replace_booking_extra_id}
  • Destinatario chiamata: {$replace_call_dst}
  • Durata chiamata senza “:” (His): {$replace_call_billsec}
  • Durata chiamata (H:i:s): {$replace_call_billsec_timed}
  • Codice classe di servizio (I, S, N): {$replace_call_type_code}
  • Nome classe di servizio (International, Special, National): {$replace_call_type_text}

DND:

  • Stato: {$replace_dnd_status}

Stato Camera:

  • Codice stato: {$replace_maid_status}

Sveglia:

  • Stato (“created”, “cancelled”, “answered”, “unanswered”): {$replace_wakeup_status}
  • Stato (“C” per created, “D” per cancelled, “A” per answered, “U” per unanswered): {$replace_wakeup_status_short_int}
  • Stato (“C” per created, “A” per cancelled, “R” per answered, “N” per unanswered): {$replace_wakeup_status_short_ita}
  • Data sveglia (Y-m-d): {$replace_timeout_date}
  • Orario sveglia (H:i:s): {$replace_timeout_time}
  • Data e ora sveglia (epoch): {$replace_timeout_datetime_epoch}
  • Data e ora sveglia (ISO 8601): {$replace_timeout_datetime_iso_8601}
  • Data e ora sveglia (RFC 5322): {$replace_timeout_datetime_rfc_5322}
  • Data e ora sveglia (Y-m-d H:i:s): {$replace_timeout_datetime}

Sveglia – Stato:

  • Stato (true, false): {$replace_wakeup_status_bool}