Gérer les clés API
Gérer les clés API
Créer, modifier, afficher/cacher, copier et supprimer vos clés API en toute sécurité
Centralisez la gestion de vos clés API depuis l’interface «Clés API & Webhooks». Cette page explique pas-à‑pas toutes les actions possibles et les bonnes pratiques à respecter.
Ce que couvre cette page
Création & édition
Créer une nouvelle clé avec validation du nom (min. 3 caractères) et modifier le nom d’une clé existante.
Afficher / Masquer & Copier
Afficher temporairement le token, le copier dans le presse‑papier et recevoir un feedback visuel.
Suppression sécurisée
Supprimer une clé après confirmation explicite et comprendre les conséquences pour vos intégrations.
Feedback utilisateur
Messages visuels (toasts / tooltips) lors des actions : création, copie, erreur, suppression.
Validation et limites
Règles de nommage (regex minimale : 3 caractères), erreurs communes et conseils pour éviter les interruptions.
Découvrir partenaires
Cartes partenaires pour installer des intégrations prêtes à l’emploi ou lier des outils externes.
Avant de commencer
Vous devez avoir les droits d’administration pour créer, modifier ou supprimer des clés. Pensez à noter le token immédiatement après sa création si l’interface ne vous le conserve pas ailleurs.
Création d’une nouvelle clé API
Workflow : créer une clé API
Étape 1 — Ouvrir le panneau de création
Cliquez sur le bouton «Créer une clé API» ou sur le contrôle d’ajout présent dans la page «Clés API & Webhooks». Un petit formulaire ou popover s’ouvre pour saisir le nom de la clé.
Étape 2 — Saisir un nom valide
Entrez un nom descriptif. Règle minimale : au moins 3 caractères (ex. “AppBackend”, “Zapier-Prod”). Évitez les noms vagues comme “clé1”. Si une validation en temps réel est disponible, corrigez les erreurs indiquées.
Étape 3 — Valider la création
Appuyez sur «Créer» ou «Enregistrer». Le système confirme la création (message visuel). Un token est alors généré et affiché.
Étape 4 — Copier et stocker le token
Copiez immédiatement le token dans un gestionnaire sécurisé (ex. coffre‑fort de mots de passe). Utilisez le bouton de copie pour obtenir le token. Si le bouton de copie ne fonctionne pas, sélectionnez manuellement le texte et faites Ctrl/Cmd + C.
Étape 5 — Vérifier l’usage
Après création, allez dans l’outil que vous connectez et collez la clé dans le champ prévu (header Api-Key ou champ dédié). Testez la connexion pour vérifier que tout fonctionne.
Étape 6 — Documenter
Notez dans votre documentation interne quelle clé correspond à quel service (nom, date de création, responsable) pour faciliter la rotation future.
Tip — Choisir un nom parlant
Préférez un format «NomAppli‑env‑responsable» (ex. “Billing‑prod‑marie”) : facilite l’identification et la rotation.
Modifier le nom d’une clé API (édition)
Workflow : éditer le nom d’une clé
Étape 1 — Lancer l’édition
Cliquez sur l’icône d’édition à côté du nom de la clé (ou sur le bouton «Modifier»). Un champ éditable apparaît inline ou dans un petit modal.
Étape 2 — Respecter la validation
Saisissez le nouveau nom en respectant la règle minimale (≥ 3 caractères). Si la validation refuse le nom, corrigez‑le avant d’enregistrer.
Étape 3 — Enregistrer
Cliquez sur «Enregistrer» ou «Valider». Un message de confirmation s’affiche si la modification a bien été prise en compte.
Étape 4 — Vérifier les impacts
Vérifiez vos listes d’intégrations si vous utilisez le nom dans des scripts ou documentations : mettez‑les à jour si nécessaire.
Étape 5 — Historique & responsabilité
Consignez le changement (qui a modifié quoi et pourquoi), utile lors d’audits ou de debugging.
Tip — Évitez les changements intempestifs
Changer le nom n’affecte généralement pas le token, mais peut perturber la traçabilité. Prévenez l’équipe avant les renommages importants.
Afficher / masquer le token et le copier dans le presse‑papier
Workflow : afficher, masquer et copier le token
Étape 1 — Localiser la clé dans la liste
Repérez la clé concernée dans le tableau «Mes connexions». La colonne «Clé API : header Api-Key» contient un champ masqué par défaut.
Étape 2 — Afficher le token
Cliquez sur l’icône œil pour basculer l’affichage : le token s’affiche en clair quand l’œil est actif, et est masqué (avec des points) sinon.
Étape 3 — Copier le token
Cliquez sur le bouton «Copier» (icône presse‑papier) : un message visuel (tooltip ou toast) confirme que la clé a été copiée. Le bouton peut changer d’état brièvement (ex. «Clé copiée !»).
Étape 4 — Si la copie échoue
Si la copie automatique échoue (navigateurs stricts), sélectionnez le token manuellement et faites Ctrl/Cmd + C, puis collez dans votre destination sécurisée.
Étape 5 — Remasquer pour la sécurité
Dès que vous avez fini, recliquez sur l’icône œil pour masquer le token. Évitez de le laisser affiché à l’écran.
Étape 6 — Mesures post‑affichage
Ne partagez jamais le token par email ou messagerie non sécurisée ; préférez un gestionnaire de secrets.
Avertissement — Ne laissez pas le token visible
Lorsque le token est affiché, toute personne ayant accès à votre écran peut le voir. Remasquez‑le immédiatement après usage.
Supprimer une clé API (avec confirmation)
Workflow : supprimer une clé API
Étape 1 — Déclencher la suppression
Cliquez sur l’icône de suppression (croix ou poubelle) à la droite de la ligne de la clé que vous voulez retirer.
Étape 2 — Lire l’avertissement
Un dialog de confirmation s’ouvre. Lisez attentivement le texte qui précise la clé concernée et les conséquences (perte d’accès pour les intégrations utilisant cette clé).
Étape 3 — Confirmer ou annuler
Confirmez la suppression en cliquant sur «Oui, supprimer» ou annulez. Dans certains cas, il peut vous être demandé de retaper le nom de la clé pour confirmer (double confirmation) — suivez les instructions affichées.
Étape 4 — Mettre à jour les intégrations
Avant de supprimer, assurez‑vous d’avoir mis à jour ou remplacé la clé dans tous les services qui l’utilisent. Après suppression, ces services perdront l’accès.
Étape 5 — Vérifier l’effet
Après suppression, testez les services liés pour vérifier qu’ils sont bien déconnectés et déployez la nouvelle clé si nécessaire.
Étape 6 — Conserver une trace
Consignez la suppression (qui, quoi, pourquoi, date) pour la traçabilité.
Conséquence importante
La suppression d’une clé est irréversible : le token ne sera plus disponible. Planifiez la transition avant suppression (prévoir une fenêtre de maintenance si nécessaire).
Avant suppression — ce qu’il faut vérifier :
- Qui utilise la clé (personne/outil)
- Remplacer la clé dans tous les systèmes
- Avertir l’équipe concernée
- Sauvegarder logs ou notes si besoin
Après suppression — contrôle à réaliser :
- Vérifier les erreurs de connexion côté services consommateurs
- Regénérer et distribuer une nouvelle clé si nécessaire
- Mettre à jour la documentation interne
Conseil de sécurité — rotation régulière
Planifiez une rotation périodique des clés (ex. tous les 3–6 mois) et supprimez les clés inutilisées. Cela réduit le risque en cas de fuite.
Utilisez un nom précis (ex. “Shopify‑prod”) et limitez l’accès au besoin. Notez la clé dans un coffre sécurisé et informez l’équipe intégration de la rotation à venir.
Frequently Asked Questions
Erreur fréquente — oublier de remplacer la clé
Ne supprimez pas une clé sans déployer sa remplaçante : cela provoquera des erreurs d’authentification sur les services connectés.
Rappel sécurité
Traitez vos clés API comme des mots de passe. Stockez‑les uniquement dans des coffres sécurisés, ne les partagez pas par email et limitez les droits si votre plateforme le permet.
Prêt à gérer vos clés ?
Accédez au panneau pour créer, éditer ou supprimer vos clés. Suivez les étapes ci‑dessus pour chaque action pour éviter toute interruption.