Comment utiliser l’API de chat dans Zendesk : Un guide étape par étape

Alors comme ça, vous cherchez à créer une intégration personnalisée, à extraire des données de chat pour un rapport ou à automatiser quelques flux de travail dans Zendesk. C’est un excellent objectif. L’utilisation de l’API vous donne le pouvoir de vraiment plier la plateforme à votre volonté.

Mais soyons réalistes un instant. Essayer de savoir par où commencer avec les API de Zendesk peut vite virer au cauchemar. Vous avez le classique Live Chat, la nouvelle plateforme Messaging, et tout un assortiment d’API différentes à choisir : REST, Real-Time, Conversations… il y a de quoi vous donner envie de fermer l’onglet du navigateur avant même d’avoir écrit une seule ligne de code.

Si cela vous semble familier, vous êtes au bon endroit. Ce guide est là pour faire le tri dans tout ce bruit. Nous allons suivre un processus simple, étape par étape, pour utiliser l’API Chat classique fournie par Zendesk. Nous allons clarifier la confusion et vous faire passer du stade de la perplexité à celui de votre premier appel API réussi.

Ce dont vous aurez besoin pour démarrer avec l’API Chat de Zendesk

Avant de nous retrousser les manches et de plonger dans le code, faisons une vérification rapide pour nous assurer que vous avez tout ce qu’il vous faut. Régler cela maintenant vous évitera bien des tracas plus tard.

Voici une petite liste de contrôle :

• Un compte Zendesk avec accès à l’API. Ceci est généralement disponible sur les plans Zendesk Suite Team et supérieurs. Si vous n’êtes pas sûr du plan que vous avez, il est judicieux de jeter un œil aux détails de votre abonnement pour confirmer.

• Des autorisations d’administrateur. Vous devrez être administrateur dans votre compte Zendesk pour générer les clés d’API. Si vous n’êtes pas administrateur, vous devrez trouver la personne qui l’est et lui demander gentiment de vous aider.

• Un client API. Vous aurez besoin d’un moyen pour envoyer des requêtes à l’API. Un outil comme Postman est fantastique pour cela car il vous permet de tester les appels API avec une interface conviviale au lieu d’écrire du code tout de suite. Alternativement, vous pouvez utiliser cURL directement dans le terminal de votre ordinateur ou vous lancer directement dans votre langage de programmation préféré.

• Des connaissances de base sur les API REST. Vous n’avez pas besoin d’être un expert, mais avoir une connaissance superficielle de concepts comme les points de terminaison, les requêtes GET et les en-têtes d’autorisation rendra ce processus beaucoup plus fluide.

Un guide étape par étape pour utiliser l’API Chat de Zendesk

Bien, maintenant que vous avez tous vos outils prêts, mettons-nous au travail. Nous commencerons par donner un sens au paysage Zendesk, puis nous nous salirons les mains avec un véritable appel API.

Étape 1 : Comprendre le paysage de l’API Chat de Zendesk (Chat vs. Messaging)

Honnêtement, le plus grand point de confusion pour quiconque débute avec les API de Zendesk est la différence entre leurs deux produits de chat : Live Chat et Messaging. Leurs noms se ressemblent, mais sous le capot, ce sont des bêtes complètement différentes qui utilisent des ensembles d’API entièrement distincts. Comprendre cela dès le départ est crucial.

Zendesk Live Chat (Le Classique)

C’est le produit de chat original, basé sur des sessions, que beaucoup d’entre nous connaissent (il s’appelait autrefois Zopim). Pensez-y comme à un appel téléphonique : un client commence un chat, c’est une conversation en direct et en temps réel, et elle se termine lorsqu’il ferme la fenêtre. Ce produit utilise un ensemble spécifique d’API, y compris l’API REST Chat, sur laquelle nous nous concentrerons dans ce guide. Ces API sont conçues pour gérer ces conversations en temps réel, administrer les agents et extraire les historiques de chat de ce système classique.

Zendesk Messaging

C’est l’approche omnicanale plus récente de Zendesk. Elle est conçue pour les conversations asynchrones, ce qui ressemble plus à des SMS ou à WhatsApp. Un client peut envoyer un message depuis votre site web, votre application mobile ou même Facebook Messenger, puis revenir plus tard pour voir la réponse. Voici la partie clé : Messaging n’utilise pas du tout les API Chat classiques. Au lieu de cela, il s’appuie sur une boîte à outils de développement différente, incluant des choses comme Sunshine Conversations et des webhooks pour les données en temps réel.

Cette séparation est un véritable casse-tête pour les équipes qui tentent de créer des automatisations unifiées. Jongler avec deux modèles d’API complètement différents est compliqué et peut consommer beaucoup de temps et de ressources. C’est une raison courante pour laquelle tant de ces projets restent bloqués en développement. C’est aussi exactement pourquoi des plateformes comme eesel AI existent. Elle fournit une seule intégration en un clic avec Zendesk qui se connecte à toutes les données de votre service d’assistance, qu’elles proviennent du Chat classique ou du Messaging moderne. Cela vous permet de construire des agents IA intelligents sans avoir à vous soucier de savoir quelle API vous êtes censé utiliser.

Étape 2 : Choisir la bonne API pour votre objectif

Même dans le monde de l’ancien Live Chat, Zendesk vous propose quelques API différentes, chacune conçue pour une tâche spécifique. Choisir la bonne dès le départ vous évitera de tourner en rond.

Voici un bref aperçu de vos options :

• API REST Chat : C’est le cheval de bataille que vous utiliserez pour la plupart des choses. Vous l’utiliseriez pour obtenir par programmation des données de chat historiques, récupérer des transcriptions, gérer vos agents et mettre à jour les informations de chat après la fin d’une conversation. Nous utiliserons cette API dans notre exemple ci-dessous.

• API Real-Time Chat : Celle-ci est une API de streaming conçue pour surveiller ce qui se passe en ce moment. Si vous avez besoin de construire un tableau de bord montrant combien de chats sont actifs ou quels agents sont en ligne à cet instant précis, c’est l’API qu’il vous faut.

• API Conversations (GraphQL) : Cette API a été initialement conçue pour créer des applications pouvant agir comme des agents, telles que des chatbots personnalisés. Cependant, Zendesk a mis cette API en mode maintenance et elle n’est plus disponible pour les nouvelles intégrations. Pour tout nouveau projet, vous devriez éviter celle-ci.

• SDK Web : Ce n’est pas une API typique, mais plutôt une bibliothèque JavaScript qui vit côté client. Elle vous donne le pouvoir de construire un widget de chat entièrement personnalisé pour votre site web, vous donnant un contrôle total sur l’apparence, l’ergonomie et l’expérience utilisateur.

Pour rendre les choses encore plus claires, voici un tableau simple pour vous aider à décider :

Étape 3 : Générer vos identifiants d’API

Pour communiquer avec l’API en toute sécurité, votre code doit prouver qu’il en a la permission. La manière standard de le faire est de créer un client OAuth dans votre tableau de bord Zendesk Chat, ce qui vous donnera les identifiants nécessaires pour générer un jeton d’accès.

Voici comment procéder :

1. Rendez-vous sur votre tableau de bord Zendesk Chat. Vous pouvez généralement le trouver dans le sélecteur de produits (l’icône à quatre carrés) de votre compte principal Zendesk Support.

2. Dans le menu de gauche, naviguez vers Paramètres > Compte, puis cliquez sur l’onglet API & SDKs.

3. Cliquez sur le gros bouton Ajouter un client API.

4. Vous verrez un formulaire. Donnez à votre client un Nom de client mémorable (quelque chose comme "Intégration Données Chat" fonctionne bien) et remplissez le nom de votre Entreprise. Pour les URL de redirection, vous pouvez simplement entrer "https://localhost" pour le moment. C’est un paramètre fictif requis pour le flux d’authentification, et c’est tout à fait suffisant pour ce que nous faisons aujourd’hui.

5. Après avoir créé le client, Zendesk vous montrera un ID Client et un Secret Client. Copiez le Secret Client et conservez-le en lieu sûr, comme dans un gestionnaire de mots de passe. C’est votre seule chance de le voir.

6. Ces identifiants sont utilisés dans un processus appelé flux d’autorisation OAuth pour obtenir un jeton porteur (bearer token) temporaire. Pour garder ce guide simple, nous allons avancer rapidement et supposer que vous avez généré un jeton d’accès à utiliser directement dans vos requêtes.

Étape 4 : Effectuer votre premier appel API

Et maintenant, le moment de vérité. Utilisons les identifiants que vous venez de générer pour extraire des données réelles de votre compte. Notre objectif est simple : récupérer une liste de vos chats les plus récents.

Le point de terminaison (Endpoint)

Le point de terminaison de l’API est simplement l’URL à laquelle vous envoyez votre requête. Pour obtenir une liste de tous les chats, le point de terminaison est "GET /api/v2/chats".

Authentification

Chaque requête que vous envoyez doit être authentifiée pour prouver que c’est bien vous. Vous le faites en incluant votre jeton d’accès dans un en-tête "Authorization". Le format est simple : "Authorization: Bearer VOTRE_JETON_D_ACCES".

Assembler le tout (Exemple avec cURL)

Utiliser cURL depuis votre terminal est l’un des moyens les plus rapides de tester une API sans chichis. Ouvrez votre terminal, remplacez VOTRE_JETON_D_ACCES par le jeton que vous possédez, et exécutez cette commande :

"`bash

curl https://www.zopim.com/api/v2/chats \

-H "Authorization: Bearer VOTRE_JETON_D_ACCES"

"`

Si tout a été configuré correctement, le serveur de Zendesk devrait répondre avec un tas de texte au format JSON contenant une liste de vos chats.

Exemple de réponse

La réponse sera un tableau JSON d’objets de chat. Voici un extrait simplifié de ce à quoi cela pourrait ressembler :

"`json

{

"chats": [

{  

  "id": "1A2B3C4D5E",  

  "visitor": {  

    "name": "Jane Doe",  

    "email": "jane.doe@example.com"  

  },  

  "history": [  

    {  

      "type": "chat.msg",  

      "display_name": "Jane Doe",  

      "msg": "Bonjour, j’ai une question sur ma dernière commande.",  

      "timestamp": 1678886400000  

    },  

    {  

      "type": "chat.msg",  

      "display_name": "Agent du support",  

      "msg": "Bonjour Jane, je serais ravi de vous aider avec ça !",  

      "timestamp": 1678886460000  

    }  

  ],  

  "timestamp": "2023-03-15T12:00:00Z"  

}  

],

"count": 1

}

"`

Et voilà, vous l’avez fait ! Vous avez utilisé avec succès l’API Chat de Zendesk pour récupérer des données réelles. Vous pouvez voir toutes sortes d’informations utiles ici, comme l’ID du chat, les détails du visiteur et l’historique complet de la conversation avec les horodatages.

Erreurs courantes à éviter en travaillant avec l’API Chat de Zendesk

Faire fonctionner votre premier appel API est une excellente première étape, mais à mesure que vous commencerez à construire des intégrations plus avancées, il y a quelques pièges courants dans lesquels il est facile de tomber. Voici quelques conseils amicaux pour vous aider à les éviter.

• 1. Utiliser la mauvaise API pour la tâche : Nous l’avons mentionné plusieurs fois, mais il est bon de le répéter car c’est l’erreur numéro un que les gens commettent. Avant d’écrire une ligne de code, vérifiez si votre objectif concerne le Live Chat classique ou le Messaging moderne. Essayer d’obtenir des données de Messaging avec l’API Chat ne fonctionnera tout simplement pas et vous laissera vous demander pourquoi rien n’apparaît.

• 2. Ignorer les limites de taux : Pour maintenir la stabilité de leur service pour tout le monde, l'API Chat de Zendesk a une limite de taux, qui est généralement d’environ 200 requêtes par minute. Si vous dépassez cette limite, vous obtiendrez une erreur "429 Too Many Requests". Une bonne pratique est de toujours vérifier l’en-tête "X-Rate-Limit-Remaining" dans la réponse de l’API pour voir combien d’appels il vous reste, et de construire une logique simple dans votre application pour faire une pause si vous approchez de la limite.

• 3. Construire un nouveau projet sur une API dépréciée : Comme nous l’avons noté plus tôt, l’API Conversations est en mode maintenance. Elle peut sembler puissante, mais démarrer un nouveau projet sur une API que Zendesk ne développe plus activement, c’est s’exposer à des problèmes futurs. Tenez-vous-en aux API activement prises en charge pour tout nouveau travail.

Ce genre de défis met en évidence les coûts cachés de la création et de la maintenance d’intégrations personnalisées. Il ne s’agit pas seulement du temps initial nécessaire pour écrire le code ; c’est le travail continu de gestion des erreurs, d’adaptation aux changements d’API et de toute la maintenance technique. C’est là que vous pourriez vous demander si construire à partir de zéro en vaut la peine. Pour une infime fraction de l’effort d’ingénierie, un outil comme eesel AI offre un puissant moteur de simulation qui vous permet de tester les performances de votre IA sur des milliers de tickets historiques avant même qu’elle n’interagisse avec un vrai client. Vous pouvez déployer une automatisation sophistiquée en toute confiance, et sans le risque de développement.

Laissez tomber le code de l’API Chat Zendesk et automatisez avec l’IA

Félicitations ! Vous avez traversé le monde parfois déroutant de l’API Chat de Zendesk, de la génération de vos identifiants jusqu’à l’extraction de données réelles. C’est une base solide pour construire les outils personnalisés que vous avez en tête.

Cependant, si votre objectif ultime est d’automatiser les résolutions, de rendre vos agents plus efficaces et de donner aux clients des réponses instantanées, tout construire vous-même est un long chemin qui nécessite beaucoup de temps de développement. Il existe un moyen beaucoup plus rapide d’y parvenir.

eesel AI se connecte directement à votre instance Zendesk en quelques minutes seulement, vous offrant un ensemble complet d’outils d’IA prêts à l’emploi. D’un agent autonome capable de résoudre des tickets par lui-même à un Copilote IA qui donne des super-pouvoirs à vos agents humains, vous pouvez être opérationnel en quelques minutes, et non en mois. Vous bénéficiez de tous les avantages d’une automatisation puissante sans les maux de tête de l’ingénierie.

Un Copilote IA rédigeant une réponse dans Zendesk, une alternative au codage avec l'API Chat de Zendesk.

Commencez votre essai gratuit dès aujourd’hui.