Guide de configuration
Apprenez à configurer vos espaces, vos clés API et les permissions de ressources
01Espaces
Un espace représente une instance isolée de votre API. Chaque espace possède son propre schéma de base de données, ses propres utilisateurs et ses propres clés d'accès. Plusieurs espaces peuvent coexister sous le même compte.
Créer un espace
- Accédez à la page Mes espaces.
- Cliquez sur Nouvel espace.
- Saisissez un nom unique (ex :
monsupersite). - Facultatif : renseignez un nom de domaine pour associer l'espace à votre site (ex :
monsupersite.fr). - Cliquez sur Créer — deux clés API (
defaultetadmin) sont automatiquement générées.
02Clés API
Chaque espace dispose d'une ou plusieurs clés API.
Une clé API est transmise dans l'en-tête X-API-KEY ou API-KEY de chaque requête HTTP
et permet d'identifier le schéma ainsi que le niveau d'accès autorisé.
Gérer les clés d'un espace
- Dans Mes espaces, cliquez sur Gérer les clés en regard de l'espace concerné.
- La section liste les clés existantes dans un accordéon ; cliquez sur une clé pour la déplier et modifier son nom, son profil ou son statut.
- En bas du panneau, remplissez le formulaire Créer une nouvelle clé pour ajouter une clé supplémentaire.
- Utilisez le bouton Enregistrer cette clé pour valider les modifications.
03Profils d'accès
Chaque clé API est associée à un profil d'accès qui détermine l'ensemble des permissions initiales accordées. Lors de la création d'une clé, les permissions sont automatiquement générées selon ce profil ; elles peuvent ensuite être affinées manuellement (voir section suivante).
| Profil | Description | Permissions par défaut |
|---|---|---|
| Lecture publique | Accès en lecture sans authentification. Idéal pour exposer des données publiques. | * / Lecture / Public |
| Client authentifié | Lecture publique + gestion de ses propres enregistrements (JWT requis). | * / Lecture / Public* / Lecture / Propriétaire* / Écriture / Propriétaire* / Suppression / Propriétaire |
| Administrateur | Accès complet en lecture, écriture et suppression sur toutes les ressources. | Lecture, Écriture, Suppression sur * (Public, Authentifié, Admin) |
04Ressources & permissions
Le système de permissions est basé sur trois dimensions : la ressource, l'action et la portée. Chaque règle accorde à la clé API le droit d'effectuer une action donnée sur une ressource donnée dans les limites d'une portée.
Ressource
La ressource désigne le nom du chemin HTTP cible (ex : products, orders).
Le caractère * est un joker qui correspond à toutes les ressources.
Une règle portant sur une ressource nommée est prioritaire sur *.
Action
| Valeur | Méthodes HTTP concernées |
|---|---|
| Lecture | GET |
| Écriture | POST · PUT |
| Suppression | DELETE |
Portée
| Valeur | Description |
|---|---|
| Public | Aucune authentification requise. L'action est autorisée pour tout appelant. |
| Propriétaire | L'utilisateur doit être authentifié (JWT valide) et être l'auteur de l'enregistrement (owner_id = son identifiant). |
| Authentifié | Un JWT valide est requis, quelle que soit la propriété de l'enregistrement. |
| Admin | Réservé aux clés dont le profil est Administrateur. Un JWT valide est également requis. |
Gérer les permissions d'une clé
- Dans Mes espaces, cliquez sur Gérer les clés.
- Dépliez la clé souhaitée dans l'accordéon.
- La section Permissions des ressources liste les règles actives avec un bouton de suppression pour chacune.
- Pour ajouter une règle, renseignez la ressource, l'action et la portée, puis cliquez sur Ajouter.
05Scénarios types
Catalogue produits public
Vous souhaitez que n'importe qui puisse lire la ressource products,
mais que seuls les administrateurs puissent la modifier.
| Clé | Ressource | Action | Portée |
|---|---|---|---|
| default (PublicClient) | products | Lecture | Public |
| admin (AdminClient) | * | Lecture / Écriture / Suppression | Admin |
Application multi-utilisateurs
Chaque utilisateur peut créer et gérer ses propres notes (notes).
| Clé | Ressource | Action | Portée |
|---|---|---|---|
| default (AuthenticatedClient) | notes | Lecture | Propriétaire |
| default (AuthenticatedClient) | notes | Écriture | Propriétaire |
| default (AuthenticatedClient) | notes | Suppression | Propriétaire |
| sync (ServiceClient) | * | Lecture / Écriture | Service |