Premiers pas avec les cibles d'intégration Apigee Intégration et proxy Apigee

Ce tutoriel explique comment utiliser l'assistant de proxy Apigee pour créer un proxy avec une cible d'intégration. Le proxy utilise une référence de déclencheur d'API d'une intégration existante pour lancer la séquence d'étapes dans l'intégration.

Les étapes ci-dessous décrivent comment configurer le proxy de cible d'intégration pour exécuter une intégration réussie lorsque le proxy est appelé.

Avant de commencer

  • Confirmez vos identifiants de connexion Apigee et les détails de votre organisation. Ces informations sont requises pour accéder à la fonctionnalité d'intégration Apigee et à l'assistant de proxy de l'UI Apigee.
  • Créez et publiez une intégration avec un déclencheur d'API et au moins une tâche.
    • Si vous n'avez pas encore créé d'intégration utilisant un déclencheur d'API, suivez les étapes décrites dans la section Premiers pas avec Apigee Integration.
    • Notez le nom de l'intégration que vous créez ou l'intégration existante que vous souhaitez utiliser, car vous en aurez besoin ultérieurement.
  • Créez un compte de service Google dans le projet Google Cloud où votre organisation Apigee a été créée, puis procédez comme suit :
    • Attribuez le rôle Demandeur Apigee Integration (roles/integrations.apigeeIntegrationInvokerRole) au compte de service. Pour en savoir plus sur les rôles prédéfinis pour Apigee Integration, consultez la page Rôles IAM prédéfinis.
    • Autorisez votre compte utilisateur (compte principal) à associer des comptes de service à des ressources grâce à l'autorisation iam.serviceAccounts.actAs. Pour en savoir plus sur les autorisations des comptes de service, consultez la page Rôles pour l'authentification du compte de service.

    Vous devez fournir ce compte de service lorsque vous déployez le proxy d'API.

Créer un proxy de cible d'intégration Apigee

Pour créer un proxy de cible d'intégration dans l'UI Apigee, 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. Dans la vue principale, cliquez sur Proxys d'API.

    Vous pouvez également sélectionner Développer > Proxys d'API dans le menu de navigation de gauche.

  4. Dans la liste déroulante Environnement, sélectionnez l'environnement dans lequel vous souhaitez créer un proxy d'API.
  5. Cliquez sur Créer.
  6. Sélectionnez Cible d'intégration dans la liste des types de proxys.

    L'assistant de création de proxy démarre.

  7. Sur la page de configuration Détails du proxy, fournissez les informations suivantes :
    • Nom : Entrez un nom pour le proxy.

      Les noms de proxy peuvent contenir des caractères alphanumériques, des tirets et des traits de soulignement.

    • Chemin de base : il est renseigné automatiquement en fonction du nom du proxy.

      Le chemin de base fait partie de l'URL utilisée pour envoyer des requêtes à votre API. Apigee utilise l'URL pour mettre en correspondance et acheminer les requêtes entrantes vers le proxy d'API approprié.

    • Description (Facultatif) : saisissez une brève description du proxy.

      Par exemple, Proxy test for Apigee Integration.

    • Région d'intégration : sélectionnez la région de l'intégration dans la liste déroulante.
    • Cible d'intégration : sélectionnez le nom de la cible d'intégration dans la liste déroulante. Notez que la liste des cibles d'intégration est renseignée en fonction de la région d'intégration sélectionnée.
    • Déclencheur : sélectionnez le déclencheur d'API associé à l'intégration dans la liste déroulante.
    • Endpoint type (Type de point de terminaison) : sélectionnez Sync (Synchroniser).
  8. Cliquez sur Next (Suivant).
  9. Sur la page de configuration Règles courantes, conservez les valeurs par défaut et cliquez sur Suivant.
  10. Dans la page Récapitulatif, cliquez sur Créer.

    Un proxy de cible d'intégration a bien été créé.

Déployez le proxy :

Pour déployer le proxy nouvellement créé, procédez comme suit :

  1. Dans l'UI d'Apigee, sélectionnez Développer > Proxys d'API.

    L'UI affiche la liste des proxys d'API et leur état de déploiement.

  2. Dans la liste déroulante Environment (Environnement), sélectionnez l'environnement dans lequel vous souhaitez déployer le proxy d'API.

  3. Cliquez sur le proxy récemment créé que vous souhaitez déployer. L'UI affiche la page Présentation par défaut.

  4. Pour déployer vos modifications, cliquez d'abord sur Déployer pour afficher la boîte de dialogue Déployer.
  5. Saisissez ce qui suit :
    • Révision : numéro de révision du proxy que vous souhaitez déployer.
    • Environnement : environnement dans lequel vous souhaitez déployer le proxy.
    • Compte de service : compte de service créé pour le proxy.
  6. Cliquez sur Déployer.

L'interface utilisateur lance le processus de déploiement de la révision sélectionnée. Le déploiement complet du proxy peut prendre jusqu'à une minute.

Une fois le proxy déployé, la colonne État de la section Déploiements affiche une icône verte indiquant que la révision 1 du proxy est déployée.

Tester le proxy de cible d'intégration

Exécutez la commande suivante à partir de la fenêtre de terminal pour appeler le proxy et déclencher l'intégration : 

curl -v https://YOUR_ENV_GROUP_HOSTNAME/PROXY_NAME

où YOUR_ENV_GROUP_HOSTNAME est le nom d'hôte d'un groupe d'environnements contenant l'environnement dans lequel votre proxy est déployé.

Exemple : 

curl -v https://my-org-prod.hybrid.e2e.apigeeks.net/my-proxy

Pour vérifier que l'intégration a bien été déclenché en appelant le proxy, procédez comme suit :

  1. Ouvrez l'interface utilisateur Apigee.
  2. Cliquez sur Développer > Intégrations.
  3. Recherchez ou sélectionnez le nom de l'intégration créée lors des étapes ci-dessus, puis cliquez sur le nom de l'intégration.
  4. Cliquez sur Logs (Journaux).
  5. Vérifiez qu'un journal d'exécution existe pour l'intégration déclenchée. Pour afficher les détails du journal, cliquez sur la ligne pour développer les détails d'exécution.

Mettre à jour la charge utile de la requête de proxy (facultatif)

Pour mettre à jour la charge utile de la requête de proxy, procédez comme suit:

  1. Dans l'UI Apigee, sélectionnez Développer > Proxys d'API dans le menu de navigation de gauche.
  2. Cliquez sur le proxy récemment créé.

    Par défaut, l'UI affiche l'onglet Présentation de ce proxy dans l'éditeur de proxy.

  3. Cliquez sur l'onglet Développer :
  4. Dans le volet Navigateur, sélectionnez Définir la requête d'intégration sous l'en-tête Règles.
  5. Annulez la mise en commentaire du bloc <Parameters>, puis saisissez les détails de vos paramètres.

    Pour spécifier des paramètres individuels, utilisez l'élément <Parameter>. Pour spécifier des tableaux de paramètres, utilisez l'élément <ParameterArray>.

  6. Cliquez sur Enregistrer.

Étape suivante

Explorez la mise en page du concepteur d'intégrations et comprenez les différents concepts d'intégration décrits dans la page Tous les concepts.