Tâche "Appeler un point de terminaison REST"

Annonce : Application Integration est désormais disponible pour votre projet Google Cloud. Vous pouvez désormais utiliser Apigee Integration et Application Integration dans le même projet Google Cloud. En savoir plus

La tâche Appeler un point de terminaison REST vous permet d'appeler n'importe quelle API REST tierce à partir de votre intégration. La réponse de l'appel d'API REST est disponible dans une variable d'intégration et peut être utilisée dans d'autres tâches en aval.

Remarque :

• La configuration réseau de la tâche Appeler un point de terminaison REST permet à celle-ci d'appeler les points de terminaison uniquement disponibles via l'Internet public. Par conséquent, la tâche ne peut pas se connecter à des hôtes ou à des adresses IP qui ne résident que dans un réseau privé tel qu'un VPC, même si ce VPC est appairé à vos autres services Google Cloud comme Apigee X.
• Cette tâche peut traiter un maximum de 50 Mo de réponse REST.

Avant de commencer

• Pour vous connecter à un point de terminaison d'authentification pour l'appel d'API REST, assurez-vous d'avoir créé un profil OAuth 2.0 ou d'avoir associé un compte de service géré par l'utilisateur à votre intégration. Si votre API ne nécessite pas d'authentification, le champ de profil d'authentification du volet de configuration des tâches peut être vide. Pour afficher la liste des configurations, consultez la section Propriétés de configuration.

  Si le profil OAuth 2.0 et un compte de service géré par l'utilisateur sont tous deux configurés pour votre intégration, le profil OAuth 2.0 est utilisé par défaut pour l'authentification. Lorsqu'aucun des deux n'est configuré, l'exécution échoue.

• Si un compte de service est associé à votre intégration, attribuez le rôle IAM requis à ce compte de service en fonction de l'URL du point de terminaison REST. Par exemple, si votre URL de point de terminaison REST appelle un service Cloud Storage, attribuez le rôle IAM requis pour le service Cloud Storage.

  Pour en savoir plus sur l'attribution d'un rôle à un compte de service, consultez la page Gérer l'accès aux comptes de service.

• Assurez-vous que VPC Service Controls n'est PAS configuré pour Apigee Integration dans votre projet Google Cloud.
  Avertissement : La fonction Cloud ne fonctionne pas ou cesse de fonctionner si VPC Service Controls est configuré pour Apigee Integration dans votre projet Google Cloud.

Configurer la tâche Appeler le point de terminaison REST

Pour configurer la tâche Appeler le point de terminaison REST :

1. Dans l'interface utilisateur Apigee, sélectionnez votre organisation Apigee.
2. Cliquez sur Développer > Intégrations.
3. Sélectionnez une intégration existante ou créez-en une en cliquant sur Créer une intégration.

   Si vous créez une intégration :

   1. Saisissez un nom et une description dans la boîte de dialogue Créer une intégration.
   2. Dans la liste des régions compatibles, sélectionnez une région pour l'intégration.
   3. Cliquez sur Créer.

   La page de conception d'intégration s'affiche.

4. Dans la barre de navigation de la page de conception d'intégration, cliquez sur +Ajouter une tâche ou un déclencheur > Tâches pour afficher la liste des tâches disponibles.
5. Cliquez sur l'élément Appeler un point de terminaison REST et placez-le dans l'éditeur d'intégration.
6. Cliquez sur l'élément Call REST Endpoint dans l'éditeur pour ouvrir le volet de configuration de la tâche Call REST Endpoint (Appeler un point de terminaison REST).
7. Configurez les champs affichés à l'aide des propriétés de configuration de la tâche, comme indiqué dans le tableau ci-dessous.

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

Propriétés de configuration

Le tableau suivant décrit les propriétés de configuration de la tâche Call REST Endpoint (Appeler un point de terminaison REST).

Property (Propriété)	Type de données	Description
Libellé	Chaîne	Facultatif : ajouter un libellé pour votre tâche.
Authentification	Chaîne	Facultatif : configure et stocke les détails d'authentification pour les connexions à des systèmes externes. Pour en savoir plus, consultez la section Créer des profils d'authentification dans Apigee Integration.
Endpoint base URL (URL de base du point de terminaison)	Chaîne	URL du point de terminaison REST sans les paramètres de requête.
Méthode HTTP	N/A	Méthode HTTP à utiliser. Vous pouvez sélectionner l'une des méthodes HTTP suivantes : DELETE GET HEAD PATCH POST PUT
URL query string parameters (paramètres de la chaîne de requête de l'URL)	Clé de la chaîne de requête : Chaîne Valeur : Chaîne	Paramètres de requête requis pour l'appel de l'API REST. Les paramètres de requête se présentent sous la forme de paires clé/valeur, où la clé correspond au nom de la clé et la valeur est la valeur de clé correspondante. Vous pouvez saisir plusieurs paires clé-valeur en cliquant sur l'icône plus.
En-têtes HTTP	Clé d'en-tête HTTP : Chaîne Valeur : Chaîne	En-têtes HTTP requis pour l'appel de l'API REST. Les en-têtes HTTP se présentent sous la forme de paires clé/valeur, où la clé correspond au nom de la clé et la valeur est la valeur de clé correspondante. Vous pouvez saisir plusieurs paires clé-valeur en cliquant sur l'icône plus.
Suivre les redirections	Booléen	Suit les redirections d'URL. Vous pouvez sélectionner l'une des valeurs suivantes : True : appelle l'URL redirigée si l'URL de base du point de terminaison est transférée à une autre URL. False : n'appelle pas l'URL redirigée si l'URL de base du point de terminaison est transférée à une autre URL.
La tâche doit échouer en cas d'erreur HTTP	Booléen	Stratégie de traitement des exceptions en cas d'échec de l'appel d'API REST. La tâche d'appel de point de terminaison REST échoue si le code de réponse HTTP est 4xx ou 5xx. Pour obtenir la liste des codes d'erreur, consultez la section Codes d'erreur. Pour les autres codes de réponse HTTP, renvoyez le code d'erreur et le message d'erreur dans la réponse. Remarque : Pour les erreurs non liées à l'appel d'API REST, telles qu'une URL incorrecte, la tâche échoue toujours, quelle que soit la valeur de cette option. Vous pouvez sélectionner l'une des valeurs suivantes : True : génère une exception. False : ne génère pas d'exception. Cependant, renvoie le code d'erreur et le message d'erreur dans la réponse.
En-tête de réponse (<Nom de la tâche>)	String	En-tête de réponse non compressé de la réponse des API REST.
Corps de la réponse (<Nom de la tâche>)	String	Corps de réponse non compressé de la réponse des API REST.
État de la réponse (<Nom de la tâche>)	String	Code de réponse HTTP et texte de code correspondant de la réponse des API REST.

Bonnes pratiques

Pour en savoir plus sur les limites d'utilisation qui s'appliquent à la tâche Appeler le point de terminaison REST, consultez la section Limites d'utilisation.

Stratégie de traitement des erreurs

Une stratégie de traitement des erreurs d'une tâche spécifie l'action à effectuer si celle-ci échoue en raison d'une erreur temporaire. Pour en savoir plus sur l'utilisation et les différents types de stratégies de traitement des erreurs, consultez la page Stratégies de traitement des erreurs.

Pour savoir comment gérer les stratégies de nouvelle tentative pour les erreurs 4xx ou 5xx, consultez l'article de blog Comment relancer la tâche d'appelant de point de terminaison REST en fonction de l'état de la réponse.