Déclencheur d'API

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

La configuration d'un déclencheur d'API dans votre intégration vous permet d'effectuer les opérations suivantes :

Pour vous aider à démarrer avec les déclencheurs d'API, consultez le tutoriel Fulfillment d'API. Le tutoriel vous explique comment créer une intégration avec un déclencheur d'API qui reçoit des requêtes 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 répertorie 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 détails du compte de service d'une intégration à tout moment depuis le volet Résumé de l'intégration de la barre d'outils d'intégration.
    4. Cliquez sur Créer.

    L'intégration que vous venez de créer s'ouvre dans l'éditeur d'intégrations.

  4. Dans la barre de navigation de l'éditeur d'intégrations, 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 avec les champs suivants :

  • Libellé : nom visible du déclencheur d'API dans votre intégration. Vous pouvez remplacer l'étiquette par le nom de votre choix.
  • Remarques : vous pouvez ajouter des remarques au déclencheur d'API pour fournir des informations supplémentaires sur le déclencheur.
  • ID du déclencheur : identifiant unique attribué au déclencheur d'API au format api_trigger/TRIGGER_NAME.
  • Variables d'entrée : variables d'entrée spécifiques au déclencheur 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 et 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 Types de données de variables acceptés.
  • Variables de sortie : variables de sortie spécifiques au déclencheur 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 dans le déclencheur d'API, cliquez sur Modifier et 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 Types de données de variables acceptés.

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

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 qui sont 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

Après avoir publié une intégration pour laquelle un déclencheur d'API est configuré, vous pouvez utiliser la méthode projects.locations.integrations.execute pour appeler ce déclencheur depuis 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 '{"triggerId":"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 des paramètres de requête prédéfinis, consultez Paramètres système.
  • TRIGGER_NAME : nom du déclencheur d'API dans votre intégration.
  • PROJECT_ID : ID de votre projet Google Cloud .
  • LOCATION : région de l'intégration, par exemple us-east1.

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 '{"triggerId":"api_trigger/test_API_1"}' \
    "https://us-east1-integrations.googleapis.com/v1/projects/demo-project/locations/us-east1/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, Application Integration 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