Passa al contenuto principale

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​

AmbitoCosa consente
bookings:readVisualizzare le prenotazioni, cercare prenotazioni, recuperare i dettagli delle prenotazioni
bookings:writeCreare nuove prenotazioni, aggiornare prenotazioni esistenti, annullare prenotazioni

Prodotti​

AmbitoCosa consente
products:readVisualizzare prodotti, livelli di inventario e informazioni sui prezzi
products:writeCreare e aggiornare prodotti, gestire le unità di inventario

Esperienze​

AmbitoCosa consente
experiences:readVisualizzare esperienze, programmi e disponibilità
experiences:writeCreare e aggiornare esperienze, gestire i programmi

Negozio​

AmbitoCosa consente
store:readVisualizzare prodotti del negozio, categorie e livelli di inventario
store:writeCreare e aggiornare prodotti e categorie del negozio, modificare l'inventario

Clienti​

AmbitoCosa consente
customers:readVisualizzare i profili dei clienti, la cronologia delle prenotazioni e i dati di contatto
customers:writeCreare e aggiornare le schede dei clienti

Personale​

AmbitoCosa consente
staff:readVisualizzare i membri del personale, i ruoli e gli orari
staff:writeGestire le schede e gli incarichi del personale

Liberatorie e moduli​

AmbitoCosa consente
waivers:readVisualizzare liberatorie, moduli e risposte inviate
waivers:writeGestire liberatorie e moduli

Sondaggi​

AmbitoCosa consente
surveys:readVisualizzare sondaggi e risposte
surveys:writeGestire i sondaggi

Promozioni​

AmbitoCosa consente
promotions:readVisualizzare codici promozionali, buoni e il loro utilizzo
promotions:writeCreare e gestire codici promozionali e buoni

Report​

AmbitoCosa consente
reports:readAccedere ai dati di reportistica su ricavi, prenotazioni, inventario e clienti

Impostazioni​

AmbitoCosa consente
settings:readVisualizzare le impostazioni dell'attività, le sedi e la configurazione
settings:writeAggiornare le impostazioni dell'attività

Webhook​

AmbitoCosa consente
webhooks:readVisualizzare le configurazioni dei webhook e i log di consegna
webhooks:writeCreare, aggiornare ed eliminare webhook

Lista d'attesa​

AmbitoCosa consente
waitlist:readVisualizzare le voci della lista d'attesa e il loro stato
waitlist:writeGestire le voci della lista d'attesa

MCP (agenti IA)​

AmbitoCosa consente
mcp:accessConnettersi 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:

IntegrazioneAmbiti consigliati
Sito web che mostra la disponibilitàproducts:read, experiences:read, store:read
Modulo di prenotazione onlinebookings:read, bookings:write, customers:read, customers:write
Sincronizzazione contabile (sola lettura)bookings:read, reports:read
App mobile completaTutti gli ambiti di lettura e scrittura
Dashboard di analisibookings:read, customers:read, reports:read
Esportazione dati clienticustomers:read
Creazione automatica di prenotazionibookings: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.

La pagina delle impostazioni API e integrazioni che mostra le chiavi API e gli ambiti


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.