Aller au contenu principal

Les autorisations d'API expliquées Growth+This feature requires the Growth+ plan or higher

Les autorisations d'API (appelées « scopes » en anglais) déterminent ce à quoi une clé API peut accéder. Lorsque vous créez une clé API, vous sélectionnez uniquement les autorisations dont votre intégration a besoin. C'est le principe du moindre privilège : chaque clé doit avoir l'accès minimal nécessaire.


Autorisations disponibles​

Réservations​

AutorisationCe qu'elle permet
bookings:readConsulter les réservations, les rechercher et afficher leurs détails
bookings:writeCréer de nouvelles réservations, modifier les réservations existantes et les annuler

Produits​

AutorisationCe qu'elle permet
products:readConsulter les produits, les niveaux de stock et les informations de tarification
products:writeCréer et modifier des produits, gérer les unités de stock

Expériences​

AutorisationCe qu'elle permet
experiences:readConsulter les expériences, les horaires et les disponibilités
experiences:writeCréer et modifier des expériences, gérer les horaires

Boutique​

AutorisationCe qu'elle permet
store:readConsulter les produits de la boutique, les catégories et les niveaux de stock
store:writeCréer et modifier les produits et les catégories de la boutique, ajuster le stock

Clients​

AutorisationCe qu'elle permet
customers:readConsulter les profils clients, l'historique des réservations et les coordonnées
customers:writeCréer et modifier les fiches clients

Personnel​

AutorisationCe qu'elle permet
staff:readConsulter les membres du personnel, leurs rôles et leurs plannings
staff:writeGérer les fiches du personnel et les affectations

Décharges et formulaires​

AutorisationCe qu'elle permet
waivers:readConsulter les décharges, les formulaires et les réponses envoyées
waivers:writeGérer les décharges et les formulaires

Enquêtes​

AutorisationCe qu'elle permet
surveys:readConsulter les enquêtes et les réponses
surveys:writeGérer les enquêtes

Promotions​

AutorisationCe qu'elle permet
promotions:readConsulter les codes promo, les bons cadeaux et leur utilisation
promotions:writeCréer et gérer les codes promo et les bons cadeaux

Rapports​

AutorisationCe qu'elle permet
reports:readAccéder aux données de rapport sur le chiffre d'affaires, les réservations, le stock et les clients

Paramètres​

AutorisationCe qu'elle permet
settings:readConsulter les paramètres de l'entreprise, les lieux et la configuration
settings:writeModifier les paramètres de l'entreprise

Webhooks​

AutorisationCe qu'elle permet
webhooks:readConsulter la configuration des webhooks et les journaux d'envoi
webhooks:writeCréer, modifier et supprimer des webhooks

Liste d'attente​

AutorisationCe qu'elle permet
waitlist:readConsulter les inscriptions sur la liste d'attente et leur statut
waitlist:writeGérer les inscriptions sur la liste d'attente

MCP (agents IA)​

AutorisationCe qu'elle permet
mcp:accessSe connecter à EquipDash via le protocole MCP pour les intégrations d'agents IA

Choisir les bonnes autorisations​

Voici quelques scénarios d'intégration courants et les autorisations dont ils ont généralement besoin :

IntégrationAutorisations recommandées
Site web affichant les disponibilitésproducts:read, experiences:read, store:read
Formulaire de réservation en lignebookings:read, bookings:write, customers:read, customers:write
Synchronisation comptable (lecture seule)bookings:read, reports:read
Application mobile complèteToutes les autorisations de lecture et d'écriture
Tableau de bord d'analysebookings:read, customers:read, reports:read
Export des données clientscustomers:read
Création automatique de réservationsbookings:write, customers:write, products:read, experiences:read

Catégories d'autorisations​

Lorsque vous créez une clé API, les autorisations sont regroupées par catégorie. Vous pouvez :

  • Tout sélectionner dans une catégorie pour activer toutes les autorisations de ce groupe.
  • Tout désélectionner dans une catégorie pour retirer toutes les autorisations de ce groupe.
  • Tout sélectionner / Tout désélectionner en haut de la liste pour tout activer ou tout désactiver en une seule fois.

La page de paramètres API et intégrations affichant les clés API et les autorisations


À savoir​

  • Une clé qui n'a pas l'autorisation requise reçoit une réponse 403 Forbidden pour le point d'accès concerné.
  • Vous pouvez modifier les autorisations d'une clé existante sans avoir à régénérer la clé.
  • Les autorisations de lecture (*:read) permettent uniquement de consulter les données. Les autorisations d'écriture (*:write) permettent de créer et de modifier des données, et incluent aussi l'accès en lecture pour ces mêmes points d'accès.
  • Pour votre sécurité, évitez d'accorder à une clé plus d'autorisations que nécessaire.