Votre clé API PushEngage authentifie les requêtes API pour un site, donc tout ce qui appelle l'API PushEngage l'utilise. Vous pouvez afficher, copier et régénérer la clé à partir des paramètres de votre site, et chaque site a sa propre clé. Ce guide vous montre comment trouver votre clé API et comment la faire pivoter en toute sécurité.
Avant de commencer
- Vous devez être connecté au tableau de bord PushEngage avec un accès au site que vous souhaitez gérer.
- La régénération de la clé remplace immédiatement l'ancienne. Toute intégration utilisant encore l'ancienne clé cessera de fonctionner jusqu'à ce que vous la mettiez à jour avec la nouvelle clé. Prévoyez donc de mettre à jour vos intégrations juste après la rotation.
- La clé API est spécifique à un site. Si vous gérez plusieurs sites, basculez d'abord vers le bon site.
Où trouver votre clé API
Dans le tableau de bord PushEngage, accédez à Paramètres du site » Détails du site et faites défiler jusqu'à la section Clé API.
Générer votre première clé API
Si le site n'a pas encore de clé API, cliquez sur Générer une nouvelle clé API. PushEngage crée la clé et confirme avec « Clé API générée avec succès ».
Copier votre clé API
Une fois qu'une clé existe, elle est masquée par mesure de sécurité. Cliquez sur Copier pour copier la clé complète dans votre presse-papiers, puis collez-la là où elle est nécessaire. La clé n'est jamais affichée en clair à l'écran, utilisez donc Copier plutôt que d'essayer de la lire.
Faire pivoter (régénérer) votre clé API
Faire pivoter la clé la remplace par une nouvelle, ce qui est la bonne démarche si la clé a pu être exposée, ou comme mesure d'hygiène périodique.
- Dans la section Clé API, cliquez sur Régénérer la clé API.
- Dans l'invite de confirmation, « Voulez-vous régénérer la clé API ? », cliquez sur Oui, Régénérer.
- PushEngage émet une nouvelle clé et confirme qu'elle a été générée.
- Copiez la nouvelle clé et mettez à jour toutes les intégrations qui utilisaient l'ancienne.
Questions fréquemment posées
La régénération de la clé va-t-elle casser mes intégrations ?
Oui, jusqu'à ce que vous les mettiez à jour. L'ancienne clé cesse de fonctionner au moment où vous la régénérez, donc toute application, plugin ou script l'utilisant échouera jusqu'à ce que vous la remplaciez par la nouvelle clé. Faites la rotation à un moment où vous pouvez mettre à jour vos intégrations immédiatement.
La clé API est-elle la même pour tous mes sites ?
Non. Chaque site a sa propre clé API. Si vous gérez plusieurs sites, assurez-vous d'être sur le bon site avant de copier ou de régénérer une clé.
Pourquoi ne puis-je voir qu'une clé masquée ?
La clé est affichée masquée à l'écran pour des raisons de sécurité. Utilisez le bouton Copier pour copier la clé complète dans votre presse-papiers.
Quand dois-je faire pivoter ma clé API ?
Faites-la pivoter si vous pensez que la clé a été exposée, lorsque quelqu'un qui y a accès la quitte, ou selon un calendrier régulier dans le cadre d'une bonne hygiène de sécurité. N'oubliez pas de mettre à jour vos intégrations avec la nouvelle clé à chaque fois.
Si vous rencontrez des problèmes, n'hésitez pas à nous contacter en cliquant ici. Notre équipe d'assistance pourra vous aider.