Spiegazione degli ambiti API Growth+This feature requires the Growth+ plan or higher
Gli ambiti API controllano a cosa può accedere una chiave API. Quando crea una chiave API, selezioni solo gli ambiti di cui la sua integrazione ha bisogno. Questo segue il principio del minimo privilegio: ogni chiave dovrebbe avere l'accesso minimo necessario.
Ambiti disponibili
Prenotazioni
| Ambito | Cosa consente |
|---|---|
bookings:read | Visualizzare le prenotazioni, cercare prenotazioni, recuperare i dettagli delle prenotazioni |
bookings:write | Creare nuove prenotazioni, aggiornare prenotazioni esistenti, annullare prenotazioni |
Prodotti
| Ambito | Cosa consente |
|---|---|
products:read | Visualizzare prodotti, livelli di inventario e informazioni sui prezzi |
products:write | Creare e aggiornare prodotti, gestire le unità di inventario |
Esperienze
| Ambito | Cosa consente |
|---|---|
experiences:read | Visualizzare esperienze, programmi e disponibilità |
experiences:write | Creare e aggiornare esperienze, gestire i programmi |
Negozio
| Ambito | Cosa consente |
|---|---|
store:read | Visualizzare prodotti del negozio, categorie e livelli di inventario |
store:write | Creare e aggiornare prodotti e categorie del negozio, modificare l'inventario |
Clienti
| Ambito | Cosa consente |
|---|---|
customers:read | Visualizzare i profili dei clienti, la cronologia delle prenotazioni e i dati di contatto |
customers:write | Creare e aggiornare le schede dei clienti |
Personale
| Ambito | Cosa consente |
|---|---|
staff:read | Visualizzare i membri del personale, i ruoli e gli orari |
staff:write | Gestire le schede e gli incarichi del personale |
Liberatorie e moduli
| Ambito | Cosa consente |
|---|---|
waivers:read | Visualizzare liberatorie, moduli e risposte inviate |
waivers:write | Gestire liberatorie e moduli |
Sondaggi
| Ambito | Cosa consente |
|---|---|
surveys:read | Visualizzare sondaggi e risposte |
surveys:write | Gestire i sondaggi |
Promozioni
| Ambito | Cosa consente |
|---|---|
promotions:read | Visualizzare codici promozionali, buoni e il loro utilizzo |
promotions:write | Creare e gestire codici promozionali e buoni |
Report
| Ambito | Cosa consente |
|---|---|
reports:read | Accedere ai dati di reportistica su ricavi, prenotazioni, inventario e clienti |
Impostazioni
| Ambito | Cosa consente |
|---|---|
settings:read | Visualizzare le impostazioni dell'attività, le sedi e la configurazione |
settings:write | Aggiornare le impostazioni dell'attività |
Webhook
| Ambito | Cosa consente |
|---|---|
webhooks:read | Visualizzare le configurazioni dei webhook e i log di consegna |
webhooks:write | Creare, aggiornare ed eliminare webhook |
Lista d'attesa
| Ambito | Cosa consente |
|---|---|
waitlist:read | Visualizzare le voci della lista d'attesa e il loro stato |
waitlist:write | Gestire le voci della lista d'attesa |
MCP (agenti IA)
| Ambito | Cosa consente |
|---|---|
mcp:access | Connettersi a EquipDash tramite il protocollo MCP per integrazioni con agenti IA |
Scegliere gli ambiti giusti
Ecco alcuni scenari di integrazione comuni e gli ambiti di cui hanno solitamente bisogno:
| Integrazione | Ambiti consigliati |
|---|---|
| Sito web che mostra la disponibilità | products:read, experiences:read, store:read |
| Modulo di prenotazione online | bookings:read, bookings:write, customers:read, customers:write |
| Sincronizzazione contabile (sola lettura) | bookings:read, reports:read |
| App mobile completa | Tutti gli ambiti di lettura e scrittura |
| Dashboard di analisi | bookings:read, customers:read, reports:read |
| Esportazione dati clienti | customers:read |
| Creazione automatica di prenotazioni | bookings:write, customers:write, products:read, experiences:read |
Categorie di ambiti
Quando crea una chiave API, gli ambiti sono raggruppati per categoria. Può:
- Usare Seleziona tutto in una categoria per attivare tutti gli ambiti di quel gruppo.
- Usare Deseleziona tutto in una categoria per rimuovere tutti gli ambiti di quel gruppo.
- Usare Seleziona tutto / Deseleziona tutto al livello superiore per attivare o disattivare tutto in una volta.

Cose da tenere presenti
- Una chiave priva dell'ambito richiesto riceverà una risposta 403 Forbidden per quell'endpoint.
- Può aggiornare gli ambiti di una chiave esistente senza doverla rigenerare.
- Gli ambiti di lettura (
*:read) consentono solo di visualizzare i dati. Gli ambiti di scrittura (*:write) consentono di creare e modificare i dati, ma includono anche l'accesso in lettura per quegli endpoint. - Per motivi di sicurezza, eviti di assegnare a una chiave più ambiti di quelli necessari.