Aller au contenu principal

Clés API

Gérez l'authentification pour accéder à l'API DataForge.

Générer une clé API

  1. Naviguez vers Paramètres > Clés API
  2. Cliquez sur Créer une clé API
  3. Entrez un nom descriptif (ex: "Backend Production")
  4. Sélectionnez les scopes (optionnel)
  5. Cliquez sur Générer
  6. Copiez immédiatement - la clé n'est affichée qu'une fois

Format des clés

df_live_xxxxxxxxxxxxxxxxxxxx   # Clés production
df_test_xxxxxxxxxxxxxxxxxxxx # Clés test/staging

Utilisation

Header Authorization

curl -H "Authorization: Bearer df_live_xxx" \
"https://api.dev-growthsystemes.com/api/queries/nodes"

Header Workspace

Requis pour les routes liées à un workspace :

curl -H "Authorization: Bearer df_live_xxx" \
-H "x-workspace-id: 550e8400-e29b-41d4-a716-446655440000" \
"https://api.dev-growthsystemes.com/api/queries/nodes"

Scopes & Permissions

ScopeNiveau d'accès
read:nodesLecture des entités
write:nodesCréation/modification/suppression des entités
read:edgesLecture des relations
write:edgesCréation/modification/suppression des relations
read:livedataLecture des flux de données
write:livedataConfiguration des sources de données
adminAccès complet au workspace
Principe du moindre privilège

N'accordez que les scopes minimum requis pour chaque intégration.

Renouvellement de clé

Procédure de renouvellement

  1. Créer une nouvelle clé avec les mêmes scopes
  2. Mettre à jour les applications pour utiliser la nouvelle clé
  3. Vérifier que tous les systèmes fonctionnent
  4. Supprimer l'ancienne clé après 24h de grâce

Renouvellement sans interruption

Gardez deux clés actives pendant la transition :

# Les deux clés fonctionnent simultanément
DATAFORGE_API_KEY_OLD="df_live_old..."
DATAFORGE_API_KEY_NEW="df_live_new..."

Bonnes pratiques de sécurité

À faire

  • Stocker les clés dans des variables d'environnement ou un gestionnaire de secrets
  • Renouveler les clés tous les 90 jours minimum
  • Utiliser des clés séparées par environnement (dev/staging/prod)
  • Surveiller l'usage via les logs d'audit
  • Révoquer immédiatement les clés compromises

À éviter

  • Commiter les clés dans le code source
  • Partager les clés entre applications
  • Utiliser les clés production en développement
  • Logger les clés dans les logs applicatifs
  • Envoyer les clés via des canaux non chiffrés

Variables d'environnement

# .env (ne jamais commiter ce fichier)
DATAFORGE_API_KEY=df_live_xxxxxxxxxxxxxxxxxxxx
DATAFORGE_WORKSPACE_ID=550e8400-e29b-41d4-a716-446655440000
DATAFORGE_API_URL=https://api.dev-growthsystemes.com

Erreurs courantes

CodeMessageCauseSolution
401UnauthorizedClé invalide/expiréeRégénérer la clé API
401Missing AuthorizationHeader absentAjouter le header Authorization: Bearer
403ForbiddenScope insuffisantAjouter le scope requis à la clé
403Workspace access deniedClé non autorisée pour ce workspaceVérifier x-workspace-id
429Too Many RequestsRate limit dépasséImplémenter un backoff, attendre le reset

Rate Limits

PlanRequêtes/minRequêtes/jour
Starter6010 000
Pro300100 000
EnterprisePersonnaliséPersonnalisé

Headers de rate limit dans la réponse :

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1699999999

Logs d'audit

Toutes les utilisations de clés API sont loggées :

  • Timestamp
  • ID de la clé (pas la clé complète)
  • Endpoint accédé
  • Status de la réponse
  • Adresse IP

Accédez aux logs d'audit via Paramètres > Clés API > Voir les logs.