Documentazione API

Esplora gli endpoint disponibili, prova le chiamate in sandbox e scarica la specifica OpenAPI.

Scarica OpenAPI JSON
Scope disponibili
Scope Accesso Nota GDPR
pazienza:customers:read Legge i clienti Solo persone con consenso terzi
pazienza:customers:write Crea e modifica i clienti Può raccogliere consenso alla creazione
pazienza:appointments:read Legge gli appuntamenti Filtrati per clienti con consenso
pazienza:appointments:write Crea e modifica appuntamenti
pazienza:invoices:read Legge le fatture attive Filtrate per clienti con consenso
pazienza:invoices:write Crea e modifica fatture
pazienza:purchase-invoices:read Legge le fatture passive
pazienza:purchase-invoices:write Crea fatture passive
pazienza:catalog:read Legge il catalogo prodotti
pazienza:catalog:write Modifica il catalogo

Web Booking API

Endpoint per integrare un form di prenotazione online sul sito del cliente. Tutti richiedono un Bearer token con gli scope indicati.

Metodo Path Descrizione Scope richiesto
GET
/api/cloud/appointment-resources/web-bookable Lista risorse (ServiceProvider) con IsBookableFromWeb = true pazienza:appointments:read
PATCH
/api/cloud/appointment-resources/{id}/web-bookable Abilita/disabilita la prenotabilità web di una risorsa — body: { "value": true } pazienza:appointments:write
GET
/api/cloud/products/web-visible Lista prodotti con IsVisibleOnWeb = true pazienza:catalog:read
PATCH
/api/cloud/products/{id}/web-visible Abilita/disabilita la visibilità web di un servizio — body: { "value": true } pazienza:catalog:write
GET
/api/cloud/appointments/slots Slot disponibili — query: serviceId, from, to, resourceId (opzionale) pazienza:appointments:read
POST
/api/cloud/appointments Crea un appuntamento (prenotazione web inclusa) pazienza:appointments:write
DELETE
/api/cloud/appointments/{id} Cancella un appuntamento (usato dal link di disdetta) pazienza:appointments:write

Autenticazione

Tutte le API richiedono un Bearer token ottenuto tramite OAuth 2.0 Authorization Code + PKCE.

Authorization: Bearer <access_token> X-Pazienza-Company: <company-id>

Il header X-Pazienza-Company specifica il tenant (azienda) per cui stai operando. In sandbox usa l'ID del tuo tenant di test, visibile nella pagina Sandbox.