Premiers pas avec Apigee Integration

Vous consultez la documentation d'Apigee X.
Consultez la documentation d'Apigee Edge.

Ce guide de démarrage rapide explique comment créer un exemple d'intégration à l'aide d'Apigee Integration. Les étapes ci-dessous 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 extraire une liste de produits d'un point de terminaison d'URL, transformer les données dans un format utilisable, puis envoyer la liste obtenue par e-mail, directement à partir de l'UI Apigee.

Avant de commencer

Avant de commencer le démarrage rapide, confirmez vos identifiants de connexion Apigee et les détails de votre organisation. Ces informations sont nécessaires pour accéder à la fonctionnalité Apigee Integration au sein du concepteur.

Créer une intégration

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

  1. Accédez à l'interface utilisateur d'Apigee et connectez-vous.
  2. Sélectionnez votre organisation dans le menu déroulant en haut à gauche de l'UI.
  3. Cliquez sur Développer > Intégrations.
  4. Cliquez sur CRÉER.
  5. Saisissez un nom et une description dans la boîte de dialogue Créer une intégration. Exemple : my-test-integration.
  6. Dans la liste des régions compatibles, sélectionnez une région pour l'intégration.
  7. Cliquez sur Create (Créer) pour ouvrir le concepteur d'intégration.

Configurer un déclencheur

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 le concepteur d'intégrations, sélectionnez Ajouter une tâche/un déclencheur > Déclencheurs pour afficher la liste des déclencheurs disponibles.
  2. Faites glisser l'élément Déclencheur d'API vers le concepteur d'intégration.
  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 :

  1. Sélectionnez Ajouter une tâche/un déclencheur > Tâches pour afficher la liste des tâches disponibles.
  2. Faites glisser l'élément Call REST Endpoint (Appeler un point de terminaison REST) vers le concepteur de l'intégration.
  3. 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://apigee-pm4-prod.apigee.net/v1/hipsters/products. Ce point de terminaison renvoie un tableau d'objets de produits, chacun avec un id, name, description, picture, price et un tableau de categories.
      • Méthode HTTP : sélectionnez GET dans la liste déroulante.
      • En-têtes HTTP supplémentaires : saisissez les en-têtes supplémentaires requis pour accéder au point de terminaison. Pour ce démarrage rapide :
        • Saisissez x-apikey dans le champ Clé d'en-tête HTTP.
        • Saisissez H7WpkpvdCAC2jSffbmKpQLVduxC6nOO9 dans le champ Valeur.
    • 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
      • Générer une erreur : False
      • Réessayer après échec
        • Lorsque l'intégration est exécutée de manière synchrone : None
        • Lorsque l'intégration est exécutée de manière asynchrone : None

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

    La configuration terminée doit correspondre à la figure ci-dessous :

    Déclencheur "Appeler un point de terminaison REST"

  4. Ajoutez une connexion de périphérie de l'élément Déclencheur d'API à l'élément Appeler le 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 le point de terminaison REST. Les points de contrôle et la ligne de périphérie deviennent jaunes, comme illustré sur l'image ci-dessous :

    concepteur d'intégration montrant une connexion Edge

    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.

Configurer la tâche Mappage de données

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

  1. Sélectionnez Ajouter une tâche/un déclencheur > Tâches pour afficher la liste des tâches disponibles.
  2. Faites glisser l'élément Mappage des données vers le concepteur de l'intégration.
  3. Cliquez sur la tâche Mappage des données dans le concepteur pour ouvrir le volet de configuration de la tâche.
  4. 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, procédez comme suit pour créer un mappage en utilisant la variable responseBody(Call REST Endpoint) comme entrée :

    1. Faites glisser le chip responseBody de la liste Variables sur la gauche de l'éditeur vers le premier champ Entrée.
    2. Cliquez sur + Ajouter une fonction dans le chip responseBody pour afficher la liste déroulante des fonctions disponibles.
    3. Vous pouvez appliquer un certain nombre de fonctions de mappage de données 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. Cliquez sur le symbole + Ajouter une fonction dans la variable responseBody pour ouvrir la liste des fonctions disponibles. Utilisez les fonctions suivantes :
      • Sélectionnez TO_JSON() pour convertir la chaîne responseBody au format JSON.
      • Cliquez à nouveau sur le symbole + Ajouter une fonction dans le chip de la variable responseBody pour sélectionner et chaîner la fonction GET_PROPERTY(). Cette fonction extrait une propriété de la charge utile JSON. Transmettez la propriété products.name 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(products.name)
      • Si vous devez supprimer ou supprimer une fonction, cliquez sur le symbole -. Cette opération supprime la dernière fonction ajoutée.
    4. Cliquez sur le premier champ de la colonne Résultat pour créer une variable contenant la valeur des données transformées. Remplissez les champs suivants :
      • Nom : saisissez JSONProdNameList.
      • Type de données : JSON
      • Cochez la case Utiliser comme sortie de l'intégration.
      • Cliquez sur Créer pour créer la variable et fermer le volet. La nouvelle variable JSONProdNameList apparaît dans la liste Variables, sur le côté gauche de l'éditeur de mappage de données.
    5. Dans l'éditeur de mappage de données, cliquez sur X pour enregistrer le mappage et fermer l'éditeur.
    6. Le mappage une fois terminé doit apparaître comme illustré dans la figure ci-dessous :

      image du mappage de données terminé et des variables

  5. Ajoutez une connexion de périphérie de l'élément Appeler le point de terminaison REST à l'élément Mapper les données en passant la souris sur un point de contrôle de l'élément Appeler le 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 Mapper les données. La périphérie indique le flux de contrôle de la tâche Appeler le point de terminaison REST vers la tâche Mappage de données.

Configurer la tâche Envoyer un e-mail

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

  1. Sélectionnez Ajouter une tâche/déclencheur > Tâches dans le concepteur d'intégration pour afficher la liste des tâches disponibles.

    Pour cette étape, utilisez la tâche Envoyer un e-mail.

  2. Faites glisser l'élément Envoyer un e-mail vers le concepteur de l'intégration.
  3. 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 :
    • Destinataires : 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 Integrations.
    • Corps de l'e-mail : sélectionnez la variable JSONProdNameList créée précédemment dans la tâche Mappage des 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.

    La configuration terminée doit correspondre à la figure ci-dessous :

    Configuration de la tâche Envoyer un e-mail

  4. À partir de l'élément Mapper les données, ajoutez une connexion de périphérie à l'élément Envoyer un e-mail en passant la souris sur un point de contrôle sur l'élément Mapper les 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. Les points de contrôle et la ligne de périphérie deviennent jaunes. La périphérie indique le flux de contrôle de la tâche Mappage de données vers la tâche Envoyer un e-mail.

Tester l'intégration

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

  1. Cliquez sur le bouton Publier dans la barre d'outils du concepteur d'intégration. La publication de l'intégration active le bouton Tester dans la barre d'outils.
  2. Cliquez sur Tester, puis sélectionnez API Trigger (Déclencheur d'API).
  3. Dans la boîte de dialogue Confirm Publish and Test (Confirmer la publication et le test), cliquez sur Publish & Test (Publier et tester).

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

Une fois l'opération terminée, l'intégration envoie un e-mail avec la liste de noms de produits à l'adresse e-mail spécifiée dans la tâche 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 :

["Vintage Typewriter", "Vintage Camera Lens", "Home Barista
Kit", "Terrarium", "Film Camera", "Vintage Record Player", "Metal Camping
Mug", "City Bike", "Air Plant"]

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 du concepteur d'intégration.
  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
    • Heure de début
    • Durée
    • ID 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.

Félicitations ! Vous avez configuré et déployé une intégration avec Apigee Integration.

Étape suivante