Aller au contenu principal

API KEY

L’API REST utilise un mécanisme d’authentification basé sur une clé API.

Chaque requête doit inclure une clé valide dans l’en-tête HTTP :

X-API-KEY: votre_cle_api

Si la clé est valide et autorisée, la requête est traitée.

Où se procurer une clé API ?​

Vous pouvez créer vos clés API sur le site my.mindbaz.com dans le menu "Integrations".

Sur cet écran, vous avez accès la liste des clés déjà créées et disponibles. Vous pouvez modifier, activer, désactiver ou supprimer une clé. Le nom, la description, les restrictions de la clé peuvent être mise à jour. En revanche, le cas d'usage et l'expiration de la clé ne peuvent pas être modifiés.

screenshots/apikeycreation.png

⚠️ Attention !
La clé API est affichée UNE SEULE FOIS après sa création pour des raisons de sécurité.

screenshots/apikeycreated.png

Comment envoyer la clé API​

Header obligatoire​

HeaderValeur
X-API-KEYClé fournie par l’administrateur

Exemple cURL​

curl -X GET "https://api.votredomaine.com/api/123/resource" \
-H "X-API-KEY: abcdef123456"

Exemple en C# (HttpClient)​

var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-API-KEY", "abcdef123456");

var response = await client.GetAsync("https://api.votredomaine.com/api/123/resource");

Cas où la clé n’est pas requise​

  • Accès à la documentation Swagger (/swagger)
  • Requêtes HTTP OPTIONS (préflight CORS)

Conditions de validité d’une clé API​

Une clé est acceptée uniquement si toutes les conditions suivantes sont remplies :

Existence​

  • La clé doit exister dans le système.

Utilisateur associé​

  • La clé doit être liée à un utilisateur valide.

Statut​

La clé doit être :

  • Active
  • Non supprimée

Date d’expiration​

Si une date d’expiration est définie, elle ne doit pas être dépassée.

Restrictions de sécurité​

  • Une clé peut être limitée à certains sites.
  • Une clé peut être limitée à certaines adresses IP.

Limitation de débit (Rate Limiting)​

Chaque clé API peut avoir une limite de requêtes par minute.

Headers retournés :​

HeaderDescription
X-RateLimit-LimitNombre max de requêtes par minute
X-RateLimit-RemainingRequêtes restantes dans la fenêtre
X-RateLimit-ResetTimestamp Unix du reset

Exemple de réponse​

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 12
X-RateLimit-Reset: 1708345200