Quand vous effectuez des demandes en utilisant les API Sunshine Conversations, l’authentification est requise pour vérifier l’identité de l’appelant. Vous pouvez utiliser l’authentification de base ou les JSON Web Tokens (JWT) pour vérifier l’identité d’un appelant. Les deux méthodes nécessitent une clé API. Vous créez la clé API en utilisant la page API Conversations.
L’accès à la page API Conversations est inclus dans les éditions Zendesk Suite Professional ou supérieurs. L’espace de travail d’agent Zendesk doit être activé pour que vous puissiez voir la page. Des packs supplémentaires sont disponibles si vous avez besoin de plus d’utilisateurs actifs mensuels (UAM) ou de notifications. Pour en savoir plus, consultez À propos des modules supplémentaires pour Zendesk Suite.
Cet article inclut les sections suivantes :
À propos des clés API
Une clé API identifie et authentifie une application ou un utilisateur, et se compose de trois parties :
- L’ID de l’application identifie votre compte Zendesk.
- L’ID de la clé utilisée en conjonction avec la clé secrète permet d’authentifier les appels API et JWT.
- La clé secrète est le mot de passe d’authentification.
Avec l’authentification de base, vous effectuez les demandes directement avec une clé API. L’ID de la clé est le nom d’utilisateur et le secret est le mot de passe.
Avec les JWT, vous signez des tokens avec une clé API, puis ils sont utilisés pour effectuer l’authentification avec l’API. L’ID de la clé est inclus dans l’en-tête JWT en tant que propriété kid et le secret signe le JWT.
Les clés API ne sont pas aussi sûres que les tokens d’authentification. Suivez les meilleures pratiques pour gérer les identifiants de façon sécurisée quand vous utilisez une clé API dans l’environnement de production.
Pour en savoir plus sur l’authentification Sunshine Conversations, consultez Authentification de l’API.
La clé API Sunshine Conversations est différente des clés d’authentification de messagerie. Les clés d’authentification de messagerie sont utilisées pour signer les identifiants qui authentifient les utilisateurs finaux qui utilisent les SDK Zendesk. La clé API décrite ici est conçue pour les appels de serveur à serveur et fournit l’accès aux API Sunshine Conversations publiques qui prennent la portée app en charge.
Création et partage des ID et de la clé de connexion
Un administrateur Zendesk doit créer une clé API et la partager avec le développeur. Vous pouvez stocker un maximum de 10 clés.
Pour créer et partager une clé API
-
Dans le Centre d’administration, cliquez sur
Applications et intégrations dans la barre latérale, puis sélectionnez API > API Conversations.
Remarque – Vous devez utiliser une édition Zendesk Suite Professional ou supérieure pour consulter cette fenêtre. - Cliquez sur Créer une clé API.
Si vous créez votre première clé, ce bouton s’affiche en bas de la page. Si vous avez déjà créé une clé, il s’affiche en haut à droite de l’écran.
- Dans la boîte de dialogue Créer une nouvelle clé, saisissez un nom unique pour la clé, puis cliquez sur Suiv.
- Dans la boîte de dialogue Copier le secret partagé, cliquez sur Copier pour chaque ID et chaque clé secrète afin de les enregistrer dans votre presse-papiers, puis cliquez sur Suiv.
Vous revenez à la fenêtre API, où la clé suivante s’affiche dans la liste.
Si vous générez une nouvelle clé, mais avez atteint votre limite de 10 clés, une notification vous demande de supprimer les clés inutilisées.
Pour supprimer une clé inutilisée
- Dans le Centre d’administration, cliquez sur Applications et intégrations dans la barre latérale, puis sélectionnez API > API Conversations.
- Placez le curseur sur la clé que vous souhaitez supprimer, puis cliquez sur le menu des options (
) et sélectionnez Supprimer. - Confirmez la suppression en cliquant sur Supprimer.