Riferimento

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:readLegge i clientiSolo persone con consenso terzi
pazienza:customers:writeCrea e modifica i clientiPuò raccogliere consenso alla creazione
pazienza:appointments:readLegge gli appuntamentiFiltrati per clienti con consenso
pazienza:appointments:writeCrea e modifica appuntamenti—
pazienza:invoices:readLegge le fatture attiveFiltrate per clienti con consenso
pazienza:invoices:writeCrea e modifica fatture—
pazienza:purchase-invoices:readLegge le fatture passive—
pazienza:purchase-invoices:writeCrea fatture passive—
pazienza:catalog:readLegge il catalogo prodotti—
pazienza:catalog:writeModifica 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-bookableLista risorse (ServiceProvider) con IsBookableFromWeb = truepazienza:appointments:read
PATCH
/api/cloud/appointment-resources/{id}/web-bookableAbilita/disabilita la prenotabilità web di una risorsa — body: { "value": true }pazienza:appointments:write
GET
/api/cloud/products/web-visibleLista prodotti con IsVisibleOnWeb = truepazienza:catalog:read
PATCH
/api/cloud/products/{id}/web-visibleAbilita/disabilita la visibilità web di un servizio — body: { "value": true }pazienza:catalog:write
GET
/api/cloud/appointments/slotsSlot disponibili — query: serviceId, from, to, resourceId (opzionale)pazienza:appointments:read
POST
/api/cloud/appointmentsCrea 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>

Il token indica già lo studio su cui operi: con il Client ID sandbox è il tuo studio di prova (vedi Sandbox), con quello di produzione lo studio dell'utente che ha autorizzato l'app. Solo se l'utente appartiene a più studi puoi sceglierne un altro con il header X-Pazienza-Company: <company-id>.