API per gli sviluppatori
| Perché | Dare allo sviluppatore dell’hotel – o a un integratore – un punto di partenza: cos’è l’API, dove vive la sua specifica e come funziona l’accesso. |
| Per chi | Allo sviluppatore che collega il proprio sistema a HotelsCalendar; al proprietario – per presentarlo al contraente. |
| Cosa ottieni | Un quadro chiaro della superficie dell’API – quali dati si possono leggere – e del processo di accesso: un token e un URL di base. |
| Limitazioni | Questo è un punto di partenza, non un riferimento dei metodi: l’elenco completo vive nella specifica, e i limiti tecnici non sono pubblicati. |
HotelsCalendar ha un’API: le stesse prenotazioni, la stessa disponibilità e gli stessi ospiti con cui lavori nell’interfaccia – in modo programmatico. Questa pagina è il punto di partenza: cos’è questa interfaccia, dove vive la sua specifica e come ottenere l’accesso. Qui non ci sono esempi di codice – al loro posto c’è la specifica.
Cos’è l’API di HotelsCalendar
Sezione intitolata “Cos’è l’API di HotelsCalendar”L’API è un’interfaccia programmatica sopra il prodotto. Consegna e accetta gli stessi dati dell’interfaccia del PMS: prenotazioni, disponibilità, ospiti. L’interfaccia è per le persone, l’API è per i programmi: un sistema gestionale, uno script o un foglio di calcolo può leggere e aggiornare i dati dell’hotel senza trasferimenti manuali.
I dati dell’API parlano la stessa lingua degli articoli di questa documentazione: prenotazioni con stati e ospiti, disponibilità per data, dati degli ospiti. Per questo, prima di collegarsi, conviene capire come il prodotto descrive queste entità – da lì comincia qualsiasi integrazione.
La specifica
Sezione intitolata “La specifica”La descrizione completa dell’API è la sua specifica OpenAPI, il file openapi.yaml: elenca tutti i metodi – cosa accetta e cosa restituisce ciascuno – e i modelli dei dati. La specifica è raggruppata in circa 24 sezioni tematiche.
La specifica si apre e si scarica dall’URL di base dell’API – l’indirizzo che viene consegnato insieme all’accesso. È la fonte di verità sulle capacità: tutto ciò che descrive, l’API lo sa fare; ciò che non c’è, l’API non lo promette.
Autorizzazione
Sezione intitolata “Autorizzazione”L’accesso all’API è a token: una chiave personale inviata con ogni richiesta. Dal token l’API capisce da quale struttura arriva la richiesta e cosa a questo accesso è consentito.
Token e URL di base arrivano insieme – al momento del collegamento (come richiederlo – più sotto). Tratta il token come una password: apre i dati della struttura, quindi resta dalla tua parte e non si pubblica mai.
Scenari tipici
Sezione intitolata “Scenari tipici”- La tua analitica. Le prenotazioni vengono esportate nel tuo strumento di BI o nel tuo foglio di calcolo, e lì si contano come ti serve – senza esportazioni manuali ogni mese.
- Sincronizzazione con i sistemi interni. Il programma gestionale o il servizio back-office dell’hotel riceve prenotazioni e modifiche dal PMS – e i dati non divergono tra i sistemi.
- Mini-servizi e widget. Un piccolo strumento sopra i dati dell’hotel – una pagina interna per il personale, una sintesi per il gestore – che legge i dati direttamente dal PMS.
Per tutti e tre gli scenari la via è una: ottenere il token, trovare i metodi che servono nella specifica, collegare il tuo sistema.
Cosa non c’è
Sezione intitolata “Cosa non c’è”- I limiti tecnici dell’API – frequenza delle richieste, volumi delle esportazioni – non sono pubblicati in questo articolo.
- L’elenco delle capacità è solo la specifica: metodi e modelli li descrive openapi.yaml, e l’articolo non promette nulla oltre.
- Come l’API cambia nel tempo – compatibilità delle versioni, come vengono comunicate le modifiche – non è promesso nemmeno su questa pagina: le condizioni si concordano al momento del collegamento.
- Qui non ci sono nemmeno guide passo a passo con codice – quel ruolo lo svolge la specifica.
Come ottenere l’accesso
Sezione intitolata “Come ottenere l’accesso”- Scrivici dalla pagina «Contatti» del sito HotelsCalendar: descrivi il compito – quale sistema si collega e di quali dati ha bisogno.
- Ti invieremo un token e l’URL di base dell’API.
- Da lì, segui la specifica: trova i metodi adatti al tuo compito e collega il tuo sistema.
Se la domanda non riguarda lo sviluppo ma la configurazione dell’hotel – parti dalla pagina di assistenza.
Vedi anche
Sezione intitolata “Vedi anche”- Assistenza e contatti – dove e come scrivere al team: anche l’accesso all’API comincia di lì.
- Glossario dei termini alberghieri – le parole del settore che incontrerai nei dati: prenotazione, disponibilità, tariffa, check-in.