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

  1. Accédez à la page Mes espaces.
  2. Cliquez sur Nouvel espace.
  3. Saisissez un nom unique (ex : monsupersite).
  4. Facultatif : renseignez un nom de domaine pour associer l'espace à votre site (ex : monsupersite.fr).
  5. Cliquez sur Créer — deux clés API (default et admin) sont automatiquement générées.
ℹ Domaine : Sans domaine configuré, l'espace fonctionne en mode test avec un quota quotidien réduit. Associer un domaine lève cette restriction et sécurise les appels CORS.

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

  1. Dans Mes espaces, cliquez sur Gérer les clés en regard de l'espace concerné.
  2. 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.
  3. En bas du panneau, remplissez le formulaire Créer une nouvelle clé pour ajouter une clé supplémentaire.
  4. Utilisez le bouton Enregistrer cette clé pour valider les modifications.
⚠ Sécurité : La valeur d'une clé (UUID) ne peut pas être modifiée après sa création. En cas de compromission, désactivez la clé concernée et créez-en une nouvelle.

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)
ℹ Changement de profil : Modifier le profil d'une clé existante remplace entièrement ses permissions par celles du nouveau profil. Les permissions personnalisées ajoutées manuellement seront supprimées.

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
LectureGET
ÉcriturePOST · PUT
SuppressionDELETE

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é

  1. Dans Mes espaces, cliquez sur Gérer les clés.
  2. Dépliez la clé souhaitée dans l'accordéon.
  3. La section Permissions des ressources liste les règles actives avec un bouton de suppression pour chacune.
  4. Pour ajouter une règle, renseignez la ressource, l'action et la portée, puis cliquez sur Ajouter.
⚠ Note : Modifier le profil d'une clé via le sélecteur Profil d'accès et cliquer sur Enregistrer cette clé réinitialise toutes les permissions avec celles du nouveau profil.

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éRessourceActionPortée
default (PublicClient)productsLecturePublic
admin (AdminClient)*Lecture / Écriture / SuppressionAdmin

Application multi-utilisateurs

Chaque utilisateur peut créer et gérer ses propres notes (notes).

CléRessourceActionPortée
default (AuthenticatedClient)notesLecturePropriétaire
default (AuthenticatedClient)notesÉcriturePropriétaire
default (AuthenticatedClient)notesSuppressionPropriétaire
sync (ServiceClient)*Lecture / ÉcritureService
ℹ Conseil : Partez toujours du profil le plus restrictif (Lecture publique ou Client authentifié) et ajoutez uniquement les permissions dont votre application a besoin. Évitez d'exposer une clé AdminClient ou ServiceClient côté client.
Une erreur inattendue s'est produite. Recharger 🗙