Un'API (in inglese Application Programming Interface, in italiano interfaccia di programmazione) è una parte di programma che un sistema software mette a disposizione di altri programmi per il collegamento. Secondo Wikipedia, un'API è un modo standardizzato con cui un software esterno può accedere alle funzioni e ai dati di un sistema.
Cosa può fare una REST API in un sistema di prenotazione appuntamenti
- Consultare gli appuntamenti liberi: le applicazioni esterne leggono quali giorni e orari sono prenotabili.
- Creare appuntamenti: le prenotazioni possono essere avviate in modo programmatico da altre applicazioni.
- Creare utenti: gli account cliente vengono creati tramite l'API nel corso della prenotazione.
- Consultare i campi del modulo: è l'interfaccia stessa a indicare quali dati richiede una prenotazione.
- Ricevere webhook: eventi come nuove prenotazioni o cancellazioni vengono trasmessi in tempo reale ai sistemi esterni tramite webhook.
- Integrazione nei sistemi CRM: i dati dei clienti provenienti dalle prenotazioni possono essere trasferiti automaticamente nei sistemi di gestione clienti.
Caratteristiche tipiche
Le moderne API web funzionano con richieste HTTP e JSON come formato dei dati. Al posto di una password viene inviato un token, che il gestore genera nell'area di amministrazione e può rinnovare in qualsiasi momento. Sono inoltre comuni un limite di richieste al minuto e l'utilizzo tra server: il token va conservato sul proprio server e non in un sito web o in un'app.
L'API di Appointmind
Appointmind mette a disposizione una REST API che rappresenta l'intero flusso di prenotazione in sei chiamate:
| Chiamata | Scopo |
|---|---|
GET /schedules | Elencare i calendari appuntamenti disponibili |
GET /reasons | Motivi appuntamento di un calendario con descrizione e durata |
GET /days | Giorni in cui è disponibile un appuntamento |
GET /slots | Orari liberi di un giorno |
GET /forms | Campi del modulo necessari per la prenotazione |
POST /bookings | Prenotare un appuntamento |
L'autenticazione avviene tramite un bearer token, generato nell'area di amministrazione in Configurazione → API; per impostazione predefinita sono consentite 300 richieste al minuto. Una panoramica è disponibile nella pagina Modulo «API (interfaccia)», una guida passo per passo in Configurare e utilizzare la REST API.