Les intégrations de conversations aident les entreprises à unifier les messages provenant de tous les canaux, tous les chatbots et toutes les applications tierces au sein d’une seule expérience et à créer des expériences interactives partout.
- Un webhook
- (facultatif) Un jeu de clés API pour interagir avec l’API publique avec une portée d’intégration (pour en savoir plus sur la création de clés API, consultez Utilisation des clés API Conversations)
Remarque – Auparavant, les intégrations de conversations s’appelaient webhooks, dans le tableau de bord Sunshine Conversations.
Vous pouvez créer des intégrations de conversations via la page Intégrations de conversations du Centre d’administration.
Vous pouvez aussi créer votre intégration en utilisant curl ou Postman.
Cet article contient les sections suivantes :
Création et configuration des conversations dans le Centre d’administration
À la page Intégrations de conversations, vous pouvez :
Création d’une nouvelle intégration de conversations
-
Dans le Centre d’administration, cliquez sur Applications et intégrations dans la barre latérale, puis sélectionnez Intégrations de conversations. La page Intégrations de conversations s’ouvre. Toutes les conversations créées précédemment s’affichent dans la liste.
Si c’est la première fois que vous créez une intégration dans le Centre d’administration, cliquez sur Créer une intégration pour afficher la page Intégrations de conversations.
- Cliquez sur Créer une intégration. La page Créer une intégration s’ouvre.
- Saisissez un nom unique pour identifier l’intégration.
- Dans la section Webhook, saisissez les informations suivantes :
-
URL du point de terminaison du webhook : l’URL cible. Quand un événement de déclencheur se produit, le webhook voit l’événement et envoie les données à l’URL cible. L’URL cible utilise le format suivant :
https://www.yourdomain.com/path
. - Données du corps du webhook : utilisez les cases à cocher pour indiquer si vous voulez inclure le schéma de l’utilisateur et les informations sur le client et l’appareil dans les données du webhook.
- Abonnements aux webhooks : sélectionnez les événements desquels vous voulez être notifiés.
-
URL du point de terminaison du webhook : l’URL cible. Quand un événement de déclencheur se produit, le webhook voit l’événement et envoie les données à l’URL cible. L’URL cible utilise le format suivant :
- Cliquez sur Enregistrer. La fenêtre Copier le secret partagé s’ouvre.
- (facultatif) Copiez l’ID du webhook et le secret partagé. Ils sont utilisés par les développeurs pour ajouter une autre couche d’authentification et ne sont pas obligatoires.
- Cliquez sur Suivant. La page de configuration de l’intégration s’ouvre. Ici, vous pouvez ajouter une clé API, si besoin est.
Ajout d’une clé API
Dans l’onglet Clé API, vous pouvez configurer l’authentification pour l’intégration. 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.
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 Intégrations de conversations. La page Intégrations de conversations s’ouvre.
- Cliquez sur l’onglet Clé API.
- 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 Intégrations de conversations.
- Cliquez sur l’onglet Clé API.
- Placez le curseur sur la clé que vous souhaitez supprimer, puis cliquez sur le menu des options () et sélectionnez Supprimer.
Consultation, modification ou suppression d’une intégration
Pour travailler sur une intégration existante
- Dans le Centre d’administration, cliquez sur Applications et intégrations dans la barre latérale, puis sélectionnez Intégrations de conversations. La page Intégrations de conversations s’ouvre.
- Placez votre curseur sur l’intégration que vous voulez mettre à jour et cliquez sur l’icône Options (), puis sélectionnez une option :
- Afficher les détails : affiche la page des détails de l’intégration, dans laquelle vous pouvez voir les ID de l’application, de l’intégration et du webhook, ainsi que des informations sur les secrets partagés, les détails des webhooks et les clés API.
- Modifier : ouvre la page Créer une intégration, à laquelle vous pouvez mettre à jour le nom de l’intégration et les détails du webhook.
- Supprimer : lance un assistant de suppression. Vous pouvez annuler et quitter l’assistant quand vous le souhaitez.
Autres méthodes d’intégration
Ces méthodes ne sont disponibles que pour les utilisateurs qui disposent d’une licence Sunshine Conversations indépendante (pas la licence incluse aux éditions Zendesk Suite Professional ou supérieures).
Pour créer une nouvelle intégration de conversations en utilisant curl
- Créez une intégration en utilisant l’API Créer une intégration et définissez
type
surcustom
. - Fournissez les paramètres nécessaires comme spécifiés dans l’API. La cible est l’URL de votre serveur et la liste de déclencheurs détermine quels événements recevoir.
Pour créer une nouvelle intégration de conversations en utilisant Postman
- Créez une intégration en utilisant l’API Créer une intégration et définissez
type
surcustom
. - Téléchargez et installez l’application Postman.
- Téléchargez la collection Postman Sunshine Conversations et configurez votre environnement.
- Dans Postman, sélectionnez Smooch > Integrations > Create Integrations.
- Fournissez les paramètres nécessaires comme spécifiés par votre type d’intégration.
Pour en savoir plus sur les API Sunshine Conversations, consultez Intégrations.
Consultez également les guides sur l’envoi et la réception de messages. Pour configurer les webhooks, utilisez les API REST.