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
| Autorisation | Ce qu'elle permet |
|---|---|
bookings:read | Consulter les réservations, les rechercher et afficher leurs détails |
bookings:write | Créer de nouvelles réservations, modifier les réservations existantes et les annuler |
Produits
| Autorisation | Ce qu'elle permet |
|---|---|
products:read | Consulter les produits, les niveaux de stock et les informations de tarification |
products:write | Créer et modifier des produits, gérer les unités de stock |
Expériences
| Autorisation | Ce qu'elle permet |
|---|---|
experiences:read | Consulter les expériences, les horaires et les disponibilités |
experiences:write | Créer et modifier des expériences, gérer les horaires |
Boutique
| Autorisation | Ce qu'elle permet |
|---|---|
store:read | Consulter les produits de la boutique, les catégories et les niveaux de stock |
store:write | Créer et modifier les produits et les catégories de la boutique, ajuster le stock |
Clients
| Autorisation | Ce qu'elle permet |
|---|---|
customers:read | Consulter les profils clients, l'historique des réservations et les coordonnées |
customers:write | Créer et modifier les fiches clients |
Personnel
| Autorisation | Ce qu'elle permet |
|---|---|
staff:read | Consulter les membres du personnel, leurs rôles et leurs plannings |
staff:write | Gérer les fiches du personnel et les affectations |
Décharges et formulaires
| Autorisation | Ce qu'elle permet |
|---|---|
waivers:read | Consulter les décharges, les formulaires et les réponses envoyées |
waivers:write | Gérer les décharges et les formulaires |
Enquêtes
| Autorisation | Ce qu'elle permet |
|---|---|
surveys:read | Consulter les enquêtes et les réponses |
surveys:write | Gérer les enquêtes |
Promotions
| Autorisation | Ce qu'elle permet |
|---|---|
promotions:read | Consulter les codes promo, les bons cadeaux et leur utilisation |
promotions:write | Créer et gérer les codes promo et les bons cadeaux |
Rapports
| Autorisation | Ce qu'elle permet |
|---|---|
reports:read | Accéder aux données de rapport sur le chiffre d'affaires, les réservations, le stock et les clients |
Paramètres
| Autorisation | Ce qu'elle permet |
|---|---|
settings:read | Consulter les paramètres de l'entreprise, les lieux et la configuration |
settings:write | Modifier les paramètres de l'entreprise |
Webhooks
| Autorisation | Ce qu'elle permet |
|---|---|
webhooks:read | Consulter la configuration des webhooks et les journaux d'envoi |
webhooks:write | Créer, modifier et supprimer des webhooks |
Liste d'attente
| Autorisation | Ce qu'elle permet |
|---|---|
waitlist:read | Consulter les inscriptions sur la liste d'attente et leur statut |
waitlist:write | Gérer les inscriptions sur la liste d'attente |
MCP (agents IA)
| Autorisation | Ce qu'elle permet |
|---|---|
mcp:access | Se 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égration | Autorisations recommandées |
|---|---|
| Site web affichant les disponibilités | products:read, experiences:read, store:read |
| Formulaire de réservation en ligne | bookings:read, bookings:write, customers:read, customers:write |
| Synchronisation comptable (lecture seule) | bookings:read, reports:read |
| Application mobile complète | Toutes les autorisations de lecture et d'écriture |
| Tableau de bord d'analyse | bookings:read, customers:read, reports:read |
| Export des données clients | customers:read |
| Création automatique de réservations | bookings: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.

À 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.