Aller au contenu

Obtenir une clé API

Toutes les Solutions Métier publiques s’authentifient avec un header x-api-key. Une clé est attachée à un ApiClient (entité non humaine qui porte les scopes et les compteurs de rate-limit).

En V1, la création de clé se fait via le support (interface self-service à venir). Vous nous indiquez :

  • Le nom logique du client (ex. prod-extractor-pipeline).
  • L’environnement cible (production, staging, sandbox).
  • Les scopes autorisés (par défaut : lecture + écriture sur les Solutions Métier que vous utilisez).

Vous recevez la clé une seule fois, en clair. Stockez-la dans votre secret manager — nous n’en conservons qu’un hash bcrypt.

ek_live_4f2a8b...e91c
PréfixeEnvironnement
ek_live_Production. Toutes les Solutions facturables.
ek_test_Sandbox. Pas de facturation, quotas réduits.

Toute requête publique passe par ce header :

Fenêtre de terminal
curl https://orchestrator.extentapi.example/v1/scraper/jobs \
-H "x-api-key: ek_live_..."

Côté serveur :

  • La clé est validée (hash + cache).
  • Le tenant + le client sont identifiés.
  • Les compteurs de rate-limit et de quotas sont mis à jour.
  • Rotation : créez une nouvelle clé, déployez-la, désactivez l’ancienne dans une fenêtre de transition.
  • Révocation : une clé révoquée est immédiatement rejetée par le cache (TTL court). En cas d’urgence (fuite), demandez une révocation manuelle.
  • Ne committez jamais une clé dans un repo Git (même privé).
  • Utilisez une clé par environnement — facilite l’isolation et l’audit.
  • Mettez en place une alerting sur les 401/403 côté votre code : c’est le signal d’une clé révoquée ou d’un scope manquant.