Consultez les connecteurs compatibles avec Application Integration.

Déclencheur d'API

Les déclencheurs d'API permettent d'appeler directement des exécutions pour des intégrations.

Configurer un déclencheur d'API dans votre intégration vous permet de:

Pour vous aider à vous familiariser avec les déclencheurs d'API, consultez le tutoriel sur le traitement des API. Le tutoriel vous montre comment créer une intégration avec un déclencheur d'API qui reçoit des requêtes d'API pour récupérer des informations sur les clients.

Ajouter un déclencheur d'API

Pour ajouter un déclencheur d'API à votre intégration, procédez comme suit :
  1. Dans la console Google Cloud, accédez à la page Application Integration.

    Accéder à Application Integration

  2. Dans le menu de navigation, cliquez sur Intégrations.

    La page Liste des intégrations s'affiche et liste toutes les intégrations disponibles dans le projet Google Cloud.

  3. Sélectionnez une intégration existante ou cliquez sur Créer une intégration pour en créer une.

    Si vous créez une intégration :

    1. Saisissez un nom et une description dans le volet Créer une intégration.
    2. Sélectionnez une région pour l'intégration.
    3. Sélectionnez un compte de service pour l'intégration. Vous pouvez modifier ou mettre à jour les informations du compte de service d'une intégration à tout moment dans le volet Récapitulatif de l'intégration de la barre d'outils d'intégration.
    4. Cliquez sur Créer.

    Cela entraîne son ouverture dans l'éditeur d'intégrations.

  4. Dans la barre de navigation de l'éditeur d'intégration, cliquez sur Déclencheurs pour afficher la liste des déclencheurs disponibles.
  5. Cliquez sur l'élément Déclencheur d'API et placez-le dans le concepteur.

Configurer un déclencheur d'API

Pour configurer un déclencheur d'API, cliquez sur l'élément Déclencheur d'API dans l'éditeur d'intégrations. Le volet de configuration du déclencheur d'API s'affiche et affiche les champs suivants:

  • Libellé:nom visible du déclencheur d'API dans votre intégration. Vous pouvez remplacer le libellé par un nom de votre choix.
  • Remarques:Vous pouvez ajouter des notes au déclencheur d'API pour fournir des informations supplémentaires à son sujet.
  • ID de déclencheur:identifiant unique attribué au déclencheur d'API au format api_trigger/TRIGGER_NAME.
  • Variables d'entrée:déclenchez des variables d'entrée spécifiques que vous pouvez utiliser pour définir la charge utile de la requête pour le déclencheur d'API.
    • Pour ajouter ou supprimer des variables d'intégration existantes au déclencheur d'API, cliquez sur Modifier, puis sélectionnez les variables requises dans le volet Variables d'entrée du déclencheur d'API.
    • Pour ajouter une variable spécifiquement pour le déclencheur d'API sélectionné, cliquez sur Modifier, puis sélectionnez + Ajouter une variable dans le volet Variables d'entrée du déclencheur d'API. Pour en savoir plus sur les types de données acceptés, consultez la section Types de données de variable acceptés.
  • Variables de sortie:déclenchez des variables de sortie spécifiques que vous pouvez utiliser pour définir la charge utile de réponse du déclencheur d'API.
    • Pour ajouter ou supprimer des variables d'intégration existantes au déclencheur d'API, cliquez sur Modifier, puis sélectionnez les variables requises dans le volet Variables de sortie du déclencheur d'API.
    • Pour ajouter une variable spécifiquement pour le déclencheur d'API sélectionné, cliquez sur Modifier, puis sélectionnez + Ajouter une variable dans le volet Variables de sortie du déclencheur d'API. Pour en savoir plus sur les types de données acceptés, consultez la section Types de données de variable acceptés.

Afficher la spécification OpenAPI de votre déclencheur d'API

L'Application Integration vous permet de générer et d'afficher de manière dynamique les spécifications OpenAPI de vos intégrations publiées configurées avec un ou plusieurs déclencheurs d'API. Pour savoir comment afficher la spécification OpenAPI, consultez Afficher la spécification OpenAPI pour votre intégration.

Appeler un déclencheur d'API à l'aide d'un appel d'API

Une fois que vous avez publié une intégration avec un déclencheur d'API configuré, vous pouvez utiliser la méthode projects.locations.integrations.execute pour appeler ce déclencheur à partir de n'importe quelle application. Cette méthode déclenche l'exécution en mode synchrone.

Syntaxe

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: TIMEOUT_SECONDS" \
    -d '{"trigger_id":"api_trigger/TRIGGER_NAME"}' \
    "https://LOCATION-integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/integrations/-:execute"

Remplacez les éléments suivants :

  • TIMEOUT_SECONDS: délai avant expiration de l'appel d'API, en secondes. Par défaut, le délai avant expiration est de 120 secondes. Pour obtenir la liste d'un ensemble prédéfini de paramètres de requête, consultez la section Paramètres système.
  • TRIGGER_NAME: nom du déclencheur d'API de votre intégration.
  • PROJECT_ID: ID de votre projet Google Cloud .
  • LOCATION: emplacement de votre projet Google Cloud .

Exemple

L'exemple suivant appelle une intégration dans la région us-east1 contenant le déclencheur d'API test_API_1 dans le projet Google Cloud demo-project:

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)"
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: 300"
    -d '{"trigger_id":"api_trigger/test_API_1"}' \
    "https://us-east1-integrations.googleapis.com/v1/projects/demo-project/locations/us-central1/integrations/-:execute"

Remarques

Lorsque vous utilisez le déclencheur d'API, la taille cumulée de toutes les variables d'entrée peut être de 8 Mo au maximum. Si la taille dépasse 8 Mo, l'intégration d'applications n'exécute pas l'intégration et vous obtenez une erreur.

Quotas et limites

Pour plus d'informations sur les quotas et les limites, consultez la section Quotas et limites.

Étape suivante