Intégration d'Apigee avec un déclencheur d'API

Ce guide de démarrage rapide explique comment créer un exemple d'intégration dans Apigee Integration. Les étapes suivantes décrivent comment configurer le déclencheur, les tâches, les périphéries, les variables et les mappages de données requis pour exécuter une intégration complète.

Dans ce guide de démarrage rapide, vous allez récupérer le nombre de vues de page à partir d'une API publique, transformer les données dans un format utilisable et envoyer la liste obtenue par e-mail, le tout depuis le concepteur d'intégration.

Créer une intégration

Pour créer une intégration, procédez comme suit :

  1. Dans l'interface utilisateur Apigee, sélectionnez votre organisation Apigee.
  2. Cliquez sur Développer > Intégrations.
  3. Cliquez sur Créer une intégration.
  4. Saisissez un nom et une description dans la boîte de dialogue Créer une intégration.

    Pour ce guide de démarrage rapide, saisissez le nom my-test-integration et la description Integration for quickstart.

  5. Sélectionnez une région pour l'intégration.
  6. Cliquez sur Créer pour ouvrir l'éditeur d'intégrations.

Ajouter et configurer un déclencheur d'API

Les déclencheurs sont nécessaires pour lancer la séquence des tâches qui composent une intégration. Tout déclencheur disponible peut être utilisé pour lancer une intégration. Pour ce guide de démarrage rapide, utilisez le déclencheur d'API.

Pour configurer le déclencheur d'API, procédez comme suit :

  1. Dans l'éditeur d'intégrations, cliquez sur Déclencheurs pour afficher la liste des déclencheurs disponibles.
  2. Cliquez sur l'élément Déclencheur d'API et placez-le dans l'éditeur d'intégrations.
  3. Cliquez sur l'élément Déclencheur d'API sur le concepteur pour ouvrir le volet de configuration du déclencheur.
  4. Apigee Integration renseigne automatiquement les propriétés du déclencheur Libellé, Nom du déclencheur et ID du déclencheur. Le champ ID du déclencheur est généré automatiquement et vous ne pouvez pas en modifier la valeur. Toutefois, vous pouvez modifier la valeur des propriétés Libellé et Nom du déclencheur.

    Les modifications apportées aux propriétés sont enregistrées automatiquement.

Ajouter et configurer des tâches

Une tâche est un ensemble d'étapes exécutable qui peut prendre des variables en entrée et générer des variables en tant que sorties. Comme pour les déclencheurs, toute tâche disponible peut être utilisée dans une intégration. Ce guide de démarrage rapide utilise les tâches Appeler un point de terminaison REST, Mappage de données et Envoyer un e-mail. Les détails de configuration pour chaque tâche sont décrits dans les étapes ci-dessous.

Configurer la tâche Appeler le point de terminaison REST

Pour configurer la tâche Appeler le point de terminaison REST, procédez comme suit :

  1. Sélectionnez Tâches pour afficher la liste des tâches disponibles.
  2. Cliquez sur l'élément Appeler un point de terminaison REST et placez-le dans l'éditeur d'intégrations.
  3. Ajoutez une connexion de type arête depuis l'élément Déclencheur d'API vers l'élément Appeler un point de terminaison REST, en passant la souris sur un point de contrôle de l'élément Déclencheur d'API, puis en cliquant sur une ligne et en la faisant glisser vers un point de contrôle sur l'élément de tâche Appeler un point de terminaison REST. La périphérie indique le flux de contrôle du déclencheur d'API vers la tâche Appeler le point de terminaison REST.

    Une arête est une connexion entre deux éléments d'une intégration. La connexion indique la direction du flux de contrôle d'un élément (tâche ou déclencheur) à un autre. Pour en savoir plus sur les arêtes, consultez la page Arêtes.

  4. Cliquez sur l'élément Appeler un point de terminaison REST sur le concepteur pour ouvrir le volet de configuration de la tâche. Définissez les propriétés suivantes :
    • Libellé : saisissez un nom personnalisé pour cette tâche. Par exemple, saisissez Call REST Endpoint Task.
    • Authentification : pour ce démarrage rapide, aucun profil d'authentification n'est requis. Pour en savoir plus sur l'utilisation de profils d'authentification pour d'autres cas d'utilisation, consultez la page Créer des profils d'authentification dans l'intégration Apigee.
    • ENTRÉE DE TÂCHE : saisissez les informations requises pour appeler le point de terminaison REST. Les informations saisies ici sont utilisées en tant qu'entrée de la tâche Appeler le point de terminaison REST. Saisissez les informations suivantes :
      • URL de base du point de terminaison : saisissez https://wikimedia.org/api/rest_v1/metrics/pageviews/per-article/en.wikipedia/desktop/user/Tree/monthly/20201001/20201031. Cette API publique de wikimedia.org renvoie le nombre de vues de page pour un article appelé Tree pour un mois donné.
      • Méthode HTTP : sélectionnez GET dans la liste déroulante.
    • SORTIE DE TÂCHE : ici, Apigee Integration spécifie trois variables pour contenir la sortie de données de réponse de l'appel du point de terminaison REST :
      • responseHeader(Call REST Endpoint) : cette variable contient les données d'en-tête de réponse associées à la tâche Appeler un point de terminaison REST. Les données de la variable sont de type String (STR).
      • responseBody(Call REST Endpoint) : cette variable contient les données de corps de réponse associées à la tâche Appeler un point de terminaison REST. Les données de la variable sont de type String (STR).
      • responseStatus(Call REST Endpoint) : cette variable contient les données d'état de réponse associées à la tâche Appeler un point de terminaison REST. Les données de la variable sont de type String (STR).
    • Affichez les détails de chaque variable en cliquant sur son nom dans le volet de configuration de la tâche. Pour ce guide de démarrage rapide, conservez les valeurs par défaut pour chacune de ces variables.
    • Les champs restants doivent contenir les valeurs par défaut suivantes :
      • Suivre les redirections : True
      • La tâche doit échouer en cas d'erreur HTTP : False
      • Stratégie de traitement des erreurs
        • Stratégie pour les exécutions synchrones : None
        • Stratégie pour les exécutions asynchrones : None

    Les modifications apportées aux propriétés sont enregistrées automatiquement.

Ajouter et configurer la tâche de mappage des données

Pour configurer la tâche de Mappage de données, procédez comme suit :

  1. Sélectionnez Tâches pour afficher la liste des tâches disponibles.
  2. Cliquez sur l'élément Mappage de données et placez-le dans l'éditeur d'intégrations.
  3. Ajoutez une connexion de type arête depuis l'élément Appeler un point de terminaison REST vers l'élément Mapper les données, en passant la souris sur un point de contrôle de l'élément Appeler un point de terminaison REST, puis en cliquant sur une ligne et en la faisant glisser vers un point de contrôle sur l'élément de tâche Mappage de données. L'arête indique le flux de contrôle depuis la tâche Appeler un point de terminaison REST vers la tâche Mappage de données.
  4. Cliquez sur la tâche Mappage des données dans le concepteur pour ouvrir le volet de configuration de la tâche.
  5. Cliquez sur Ouvrir l'éditeur de mappage de données.

    L'éditeur de mappage de données vous permet de mapper les variables d'entrée avec les variables de sortie souhaitées à l'aide des fonctions de transformation disponibles. Le résultat est ensuite disponible en tant que variable pour toute autre tâche ou tout autre déclencheur d'intégration. Pour en savoir plus sur la transmission de données en tant que variables, consultez la page Utiliser des variables dans Apigee Integration.

    Pour ce guide de démarrage rapide, vous pouvez créer un mappage en utilisant la valeur responseBody(Call REST Endpoint) comme entrée :

    1. Faites glisser la variable responseBody du volet responseBody vers la première ligne responseBody.
    2. Cliquez sur + (Ajouter une fonction) dans la puce de variable responseBody pour afficher la liste déroulante des fonctions disponibles.
    3. Vous pouvez appliquer un certain nombre de fonctions pour transformer les données de la variable d'entrée.

      Dans ce cas, vous pouvez convertir la charge utile au format JSON, puis itérer le tableau de réponses pour obtenir la liste des noms de produits requis pour vos notifications par e-mail.

      • Sélectionnez TO_JSON() pour convertir la chaîne responseBody au format JSON.
      • Cliquez à nouveau sur + (Ajouter une fonction) dans la puce de variable responseBody pour sélectionner et relier la fonction GET_PROPERTY().
      • Pour ajouter le paramètre d'entrée de GET_PROPERTY(), cliquez sur Variable ou valeur et pour Valeur saisissez items.

        Cette fonction extrait une propriété de la charge utile JSON. Transmettez la propriété items en tant que paramètre pour cette fonction. Vous obtiendrez une liste des noms de produits SEULEMENT, sans aucune autre information sur le produit. La fonction devrait se présenter comme suit : 

        responseBody(Call REST Endpoint).TO_JSON().GET_PROPERTY(items)

      • Si vous devez retirer ou supprimer une fonction, cliquez sur le symbole -.
    4. Cliquez sur le premier champ de la colonne Résultat pour créer une variable de sortie contenant la valeur des données transformées. Remplissez les champs suivants :
      • Nom : saisissez JSONList.
      • Type de données : JSON.
      • Cochez la case Utiliser en tant que sortie de l'intégration.
      • Cliquez sur Créer pour créer la variable et fermer le volet. La nouvelle variable JSONList apparaît dans la liste JSONList, sur le côté gauche de l'éditeur de mappage de données.
    5. Fermez l'éditeur de mappage de données une fois le mappage terminé. Toutes les modifications seront enregistrées automatiquement.

Ajouter et configurer la tâche d'envoi d'e-mails

Pour configurer la tâche Envoyer un e-mail :

  1. Sélectionnez Tâches dans l'éditeur d'intégrations pour afficher la liste des tâches disponibles.
  2. Cliquez sur l'élément Envoyer un e-mail et placez-le dans l'éditeur d'intégrations.
  3. À partir de l'élément Mappage de données, ajoutez une connexion de type arête à l'élément Envoyer un e-mail, en passant la souris sur un point de contrôle sur l'élément Mappage de données, puis en cliquant sur une ligne et en la faisant glisser vers un point de contrôle sur l'élément de tâche Envoyer un e-mail. L'arête indique le flux de contrôle depuis la tâche Mappage de données vers la tâche Envoyer un e-mail.
  4. Cliquez sur l'élément Envoyer un e-mail sur le concepteur pour ouvrir le volet de configuration de la tâche. Définissez les propriétés suivantes :
    • Destinataire(s) : saisissez votre adresse e-mail. Vous allez utiliser cette adresse e-mail pour confirmer la réussite de l'intégration.
    • Objet : saisissez Email from Apigee Integration.
    • Corps en texte brut : sélectionnez la variable JSONList créée précédemment dans la tâche Mappage de données.
    • Vous pouvez laisser les autres options dans la configuration par défaut.

    Les modifications que vous avez apportées aux propriétés sont enregistrées automatiquement.

Vérifier les connexions de type arête requises

Vérifiez que vous avez ajouté une connexion de type arête entre les éléments de votre intégration. La connexion indique la direction du flux de contrôle d'un élément (tâche ou déclencheur) à un autre. Pour en savoir plus sur les arêtes, consultez la page Arêtes.

La connexion effectuée doit apparaître comme illustré dans la figure ci-dessous :

Image montrant le flux de démarrage rapide Image montrant le flux de démarrage rapide

Tester l'intégration

Pour tester la nouvelle intégration, procédez comme suit :

  1. Cliquez sur Tester dans la barre d'outils de l'éditeur d'intégrations.

    Le volet Tester l'intégration s'affiche.

  2. Cliquez sur Tester l'intégration.

Pour en savoir plus sur les tests, consultez la page Tester et publier des intégrations.

Une fois l'intégration terminée, l'intégration envoie un e-mail avec les valeurs JSON à l'adresse e-mail spécifiée dans la tâche Send Email (Envoyer un e-mail). Confirmez la réception de l'e-mail dans votre client de messagerie.

L'e-mail envoyé par l'intégration doit contenir un corps semblable au suivant : 

[{
   "project": "en.wikipedia",
   "article": "Tree",
   "granularity": "monthly",
   "timestamp": "2020100100",
   "access": "desktop",
   "agent": "user",
   "views": 33828.0
}]

En plus de vérifier le contenu de l'e-mail, vous pouvez inspecter les journaux pour afficher l'état et la charge utile d'une intégration donnée. Pour afficher les journaux :

  1. Cliquez sur Journaux dans la barre d'outils de l'éditeur d'intégrations.
  2. La page Journaux d'exécution vous permet d'afficher les détails de chaque tentative d'exécution d'une intégration. Chaque entrée inclut les détails de la tentative d'exécution, y compris les suivants :
    • Nom de l'intégration
    • ID d'exécution
    • État
    • Start time
    • Durée
    • Version d'intégration
    • ID du déclencheur
  3. Cliquez sur la flèche de développement (>) à côté de l'intégration exécutée pour afficher une liste développée des tâches et des variables dans l'intégration, ainsi que l'état de la tâche et les charges utiles variables.