Obtenir une clé API
Toutes les Solutions Métier publiques s’authentifient avec un header
x-api-key. Une clé est rattachée à un client API (entité non humaine de
votre tenant qui porte ses scopes et ses compteurs de rate-limit).
Créer une clé
Section intitulée « Créer une clé »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 à sens unique.
apk_live_a1b2c3_4f2a8b...e91cLes clés sont au format apk_<env>_<id>_<secret>.
| Préfixe | Environnement |
|---|---|
apk_live_ | Production. Toutes les Solutions facturables. |
apk_test_ | Sandbox. Pas de facturation, quotas réduits. |
Utilisation
Section intitulée « Utilisation »Toute requête publique passe par ce header :
curl https://api.extentapi.example/v1/scraper/jobs \ -H "x-api-key: apk_live_..."À chaque requête, votre clé est validée, votre tenant résolu, et vos compteurs de rate-limit et de quotas mis à jour.
Rotation et révocation
Section intitulée « Rotation et révocation »- 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.
Bonnes pratiques
Section intitulée « Bonnes pratiques »- 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/403côté votre code : c’est le signal d’une clé révoquée ou d’un scope manquant.