Français
  1. 助手Zen亚博desk
  2. Assistants et automatisation
  3. Assistants personnalisés (Créateur de workflow) - Documentation

Utilisation de l’étape Effectuer un appel API dans le Créateur de workflow

Aimee Spanier
  • Modifié
Zendesk Documentation Team

Mon édition

L’étapeEffectuer un appel APIvous permet de configurer un appel API à un autre système, un système CRM ou ERP par exemple, ou de transférer les détails d’une conversation à un point de terminaison externe, comme Amazon Event Bridge ou Google Analytics.

Dans cet article, nous allons voir les procédures permettant d’inclure et de configurer cette étape dans un workflow de bot

Pour un aperçu de l’étapeEffectuer un appel APIet de ses règles de configuration, consultezTypes d’étape de bot. Effectuer un appel API.

Cet article contient les sections suivantes :

Ajout d’une étape Effectuer un appel API à votre bot

L’ajout d’une étapeEffectuer un appel APIà votre bot inclut plusieurs tâches distinctes.

Les procédures ci-dessous supposent que vous avez déjàcréé un workflow de botque vous ajoutez cette étape à ce bot.

Pour ajouter une étape Effectuer un appel API

  1. Ouvrez le bot dans le Créateur de workflow.
  2. Cliquez sur l’icôneAjouter nouv.à l’endroit où vous voulez insérer l’étape (à la fin d’une branche ou entre deux étapes existantes).
  3. Dans le volet de configuration, cliquez surEffectuer un appel API.
  4. Saisissez des informations descriptives pour cette étape (votre équipe peut voir ces informations mais pas les clients) :
    • Nom: un nom pour l’appel qui permet à votre équipe de l’identifier facilement.
    • Description(facultatif) : une courte description de l’action qu’effectue l’appel.
  5. Continuez avec la procédure décrite dans la sectionAjout des de l被细节ci-dessous.

Ajout des de l被细节

Utilisez la section Détails de l’API pour configurer l’appel HTTP que vous voulez effectuer, notamment la méthode de la demande HTTP, l’emplacement de la source externe et des en-têtes supplémentaires si besoin est. Les étapes ci-dessous sont la suite de la procédure de la section précédente.

Pour ajouter les détails de l’API

  1. Dans le volet de configuration, cliquez surDétails de l’API.
  2. Dans le menu déroulant, sélectionnez uneMéthode de la demande:
    • GETrécupère les données à partir d’un serveur de la ressource externe. C’est la méthode le plus souvent utilisée.
    • POSTenvoie des données pour créer ou mettre à jour une ressource dans un système externe. Si la ressource existe déjà, les données envoyées modifient la ressource.
    • PUTenvoie des données pour mettre à jour ou créer une ressource. Si la ressource existe déjà, les données envoyées remplacent la ressource.
    • PATCHenvoie des données pour mettre à jour une ressource sur un site externe. Cette méthode sert à appliquer des modifications partielles à la ressource.
    • DELETEsupprime la ressource de l’emplacement externe.
  3. Saisissez uneURL du point de terminaison. L’URL du point de terminaison est l’emplacement de la ressource externe à laquelle vous vous connectez. L’URL de point de terminaison prend en charge le protocolehttps://. Vous pouvez inclure desvariablesdans le chemin de l’URL ou dans les valeurs de chaînes de la requête. Pour en savoir plus, consultezTransfert de variables dans un appel API.
  4. (facultatif) Sélectionnez une connexion pour l’authentification de l’appel API.
    Remarque –Vous devezcréer une connexionavant de l’utiliser dans l’étapeEffectuer un appel API.
  5. Si besoin est, saisissez la clé et la valeur pour un en-tête facultatif.
    Important :n’utilisez pas les en-têtes pour l’authentification. Utilisez plutôt lesconnexions API.

    Les étapesEffectuer un appel APIqui incluent un en-tête associé à l’authentification, commeauthorizationoux-api-key, échouent automatiquement. En cas d’échec de l’étapeEffectuer un appel API, la conversation suit la brancheÉchec de l’appel APIde l’étape.

  6. Cliquez surEffectuer un appel APIpour tester l’appel API. Si desvariablessont ajoutées à l’URL ou à son l’URL, vous pouvez inclure des données de test facultatives pour votre service externe afin de vérifier le bon fonctionnement de l’appel API. Notez que cela effectuera une demande HTTP vers l’URL de point de terminaison configurée.

Transfert de variables dans un appel API

Quand vous saisissez uneURL du point de terminaisonpour un appel API, vous pouvez inclure desvariablesdans le chemin de l’URL ou dans les valeurs de chaînes de la requête. Cela vous permet de transférer des données de la conversation à un système externe.

Par exemple, un bot de messagerie peut inviter un client à fournir un numéro de commande en utilisant l’étapeDemander des détails. Le bot peut ensuite utiliser une étapeEffectuer un appel APIpour obtenir le statut de livraison de la commande auprès de votre magasin en ligne.

Vous ne pouvez pas utiliser de variables dans le domaine ou sous-domaine d’une URL du point de terminaison. Le tableau suivant inclut des exemples de valeurs d’URL du point de terminaisonvalides et non valides.

URL du point de terminaison valide URL du point de terminaison non valide
https://myshopify.com/admin/api/orders/order_number.json

Récupérez une commande en spécifiant l’ID de la commande sur Shopify.

https://domain.com/api/search?input=value

Les variables ne peuvent pas être ajoutées au domaine/sous-domaine.

https://maps.googleapis.com/maps/api/place?input=city_name

Récupérez un lieu via des recherches de mots-clés de l’API de lieux (Places) de Google.

https://example.com/api/search?key=value

Les variables ne peuvent pas être ajoutées à la clé de la chaîne de requête.

Si une variable est vide ou n’est pas valide, le bot ignore cette variable pendant une conversation.

Remarque –Les valeurs des variables ne sontpasautomatiquement traduites. Ne l’oubliez pas si vous utilisez la traduction automatique dans vos conversations de messagerie.

Enregistrement des variables de la réponse API

然后得到配置等证人l 'appel les细节API, vous pouvez enregistrer les valeurs de la réponse JSON de l’appel API sous la forme devariables. Vous pouvez enregistrer un maximum de huit variables dans une étapeEffectuer un appel API.

Pour créer une variable à partir des données de réponse

  1. Dans le volet de configuration, cliquez surEffectuer un appel API.
  2. Développez l’accordéon et identifiez les données provenant du système externe que vous voulez convertir en variable.
    Conseil :cliquez sur l’onglet Corps de la réponse pour voir la réponse brute renvoyée par le système externe.
  3. Cliquez surEnregistrer.
  4. Donnez un nom à la nouvelle variable. Les noms de variables ne peuvent inclure que des lettres minuscules, des chiffres et des traits de soulignement.

À propos des branches de l’étape

L’étapeEffectuer un appel APIest une étape d’embranchement. Quand vous ajoutez cette étape, les réponses du bot sont divisées selon que l’exécution de l’API a réussi ou non.

Si l’API a renvoyé un code de réponse de 400, 500 ou 200 avec des données dans lesquelles manquent une ou plusieurs variables, le bot suivra la branche d’échec.

Attention :si vous utilisez l’étapeEffectuer un appel API, vous comprenez et acceptez que le système externe auquel vous vous connectez est un service non proposé par Zendesk (tel que défini dans l’Accord sur les services principaux). Zendesk n’exécute pas et ne contrôle pas les services non proposés par Zendesk activés via l’utilisation de la fonctionnalité Extensions du Créateur de workflow et Zendesk n’est pas responsable des obligations de conformité légales ou réglementaires, qu’elles vous concernent ou qu’elles concernent les services non proposés par Zendesk.
    Retour en haut

    0 Commentaires

      Vous devezvous connecterpour laisser un commentaire.

      Articles associés

      Réalisé par Zendesk