Clés API

Les clés API sont créées et gérées depuis la console développeur. Elles vous permettent d'authentifier vos requêtes à l'API RestifyDocs.

Créer une clé

Depuis la console développeur, rendez-vous sur la page API Keys et cliquez sur "Nouvelle clé" :

  1. Nommez votre clé — Choisissez un nom descriptif (ex: "Backend production", "Service webhook", "Dev local").
  2. Choisissez l'environnement — test pour le développement, live pour la production.
  3. Sélectionnez les permissions — Cochez uniquement les scopes nécessaires :
    • documents:generate — Générer des PDF
    • documents:read — Lire et lister les documents
    • documents:bulk — Génération en masse
    • templates:read — Lire les templates
    • templates:write — Créer et modifier les templates
  4. Copiez votre clé — La clé complète (ex: dk_live_aBcDeFg...) n'est affichée qu'une seule fois. Copiez-la immédiatement.
Clé affichée une seule fois
RestifyDocs ne stocke qu'un hash de votre clé. Si vous la perdez, vous devrez en créer une nouvelle et révoquer l'ancienne.

Gérer vos clés

La page API Keys de la console affiche toutes vos clés avec :

  • Préfixe — Les 12 premiers caractères pour identifier la clé
  • Environnement — test ou live
  • Scopes — Les permissions attribuées
  • Dernière utilisation — Date de la dernière requête effectuée avec cette clé

Révoquer une clé

Cliquez sur l'icône de suppression à côté de la clé à révoquer, puis confirmez. La révocation est immédiate : toute requête utilisant cette clé recevra une erreur 401 Unauthorized.

La révocation est irréversible. Si des services utilisent cette clé, ils perdront immédiatement l'accès à l'API. Créez une nouvelle clé avant de révoquer l'ancienne pour éviter toute interruption.

Bonnes pratiques

Une clé par service

Créez une clé dédiée pour chaque service ou application. Cela permet de révoquer l'accès d'un service sans affecter les autres.

Variables d'environnement

Stockez vos clés dans des variables d'environnement (RESTIFYDOCS_API_KEY), jamais dans le code source ou les fichiers de configuration versionnés.

Moindre privilège

N'attribuez que les scopes strictement nécessaires. Un service de génération n'a pas besoin de templates:write.

Rotation régulière

Renouvelez vos clés périodiquement, surtout si un collaborateur quitte l'équipe ou si vous suspectez une compromission.

Prochaine étape

Configurez les informations de votre organisation pour les documents générés.

Organisation →