Dans cet article, nous vous expliquons ce qu'est une clé API et comment vous pouvez en créer une nouvelle ou en supprimer une ancienne.
Qu'est-ce qu'un clé API ?
Une clé API est un code utilisé pour identifier et authentifier une application ou un utilisateur. Elle fait office d'identifiant unique et fournit un jeton secret à des fins d'authentification.
Par exemple, vous pouvez utiliser une clé API pour connecter votre site web ou votre système d'information à Brevo. Vous pourrez ainsi déclencher certaines actions automatiquement ou manuellement entre les deux.
Avec une clé API, vous pouvez aussi vous connecter à notre API pour ajouter automatiquement de nouveaux contacts, ou même effectuer des tâches plus complexes, comme par exemple :
- Créer et planifier des campagnes depuis l'API.
- Exporter des utilisateurs inclus sur des listes spécifiques.
- Exporter des campagnes de statistiques, etc..
Pour accéder à la liste complète des commandes mises à votre disposition avec notre API, veuillez consulter la documentation de notre API.
Où puis-je trouver mes clés API ?
Pour protéger vos clés API et les rendre plus sûres, vos clés API existantes ne sont pas visibles depuis votre compte Brevo. Seuls les derniers chiffres des clés sont affichés sur la page SMTP & API afin que vous puissiez faire la différence entre plusieurs clés si nécessaire :
C'est pourquoi nous vous conseillons vivement de stocker votre clé API dans un environnement sûr lorsque vous la créez. Si vous avez perdu votre clé API, nous vous recommandons d'en créer une nouvelle, de la conserver dans un environnement sûr et de remplacer la précédente.
Créer une clé API
Lorsque vous configurez une intégration avec votre compte Brevo, vous aurez peut-être besoin de créer une nouvelle clé API :
- Cliquez sur le nom de votre compte > SMTP & API.
- Cliquez sur Générer une nouvelle clé API.
- Donnez un nom à votre clé API. Faites bien attention à ce qu'il précise dans quelle intégration sera utilisée cette clé API, afin de la reconnaître facilement.
- Cliquez sur Générer.
- Copiez votre clé API et conservez-la dans un environnement sûr.
❗️ ImportantVotre clé API est uniquement visible pendant cette étape. Une fois votre clé API créée, vous ne pourrez plus la copier et vous devrez en créer une nouvelle si vous la perdez. - Cliquez sur OK.
Vous avez bien créé une nouvelle clé API.
Supprimer une clé API
Si votre compte est compromis ou si vous n'utilisez plus une intégration qui nécessite d'utiliser une clé API particulière, vous pouvez supprimer cette clé API :
- Cliquez sur le nom de votre compte > SMTP & API.
- Sélectionnez la clé API que vous souhaitez supprimer.
- Cliquez sur Supprimer la clé API.
Vous avez bien supprimé votre clé API.
Les bonnes pratiques avec les clés API
Les clés API donnent un accès complet à votre compte Brevo et doivent être protégées de la même manière qu'un mot de passe. Voici quelques bonnes pratiques à garder à l'esprit lorsque vous utilisez des clés API :
- Utilisez une clé API différente pour chaque intégration et indiquez le nom de l'intégration dans le nom de la clé API afin de savoir exactement quelle clé correspond à chaque intégration. Ainsi, si une clé API est compromise, vous pouvez la supprimer sans perturber vos autres intégrations.
- Conservez vos clés API dans un environnement sûr, et non dans un document Word ou sur un post-it.
- Ne rendez pas votre clé API visible au public. Assurez-vous de cacher votre clé API, ou mieux encore, de l'effacer complètement dans vos impressions écran ou vos captations en vidéo.
- N'envoyez jamais une clé API par email, car toute personne piratant votre boîte email pourrait accéder à votre compte Brevo.
- Vous devez toujours supprimer les clés API qui ne sont plus utilisées afin de limiter les risques de fuite.
🤔 Vous avez des questions ?
Pour toute question, n’hésitez pas à contacter notre service client en créant un ticket à partir de votre compte. Si vous n’avez pas encore de compte, vous pouvez nous contacter ici.
Si vous avez besoin d'aide pour un projet impliquant Brevo, nous pouvons vous mettre en relation avec un Partenaire Brevo certifié.