Appeler une API externe

Appelez une API Representational State Transfer (REST) authentifiée, gérez la réponse et extrayez les données pour les nœuds de workflow en aval.

Ce que vous créerez : un workflow qui appelle une API Representational State Transfer (REST) authentifiée, gère la réponse et rend les données extraites disponibles aux nœuds en aval. Il s'agit de l'un des modèles les plus courants dans Flow - il s'applique à tout système qui expose un point de terminaison HTTP.

Éléments requis

• Un compte UiPath Automation Cloud avec accès à Maestro Flow.
• L'URL de base de l'API cible, le chemin du point de terminaison et les détails d'authentification (clé d'API, jeton de porteur ou identifiants d'authentification de base).

Nœuds utilisés

• Déclencheur manuel - démarre le workflow à la demande
• Demande HTTP - appelle l'API REST
• Transformation des données - extrait les champs dont vous avez besoin de la réponse
• Script - enregistre les échecs sur le chemin d'erreur de la demande HTTP

Étapes

1. Créer un nouveau Flow et ajouter un déclencheur

1. Ouvrez Maestro → Flow et créez un nouveau workflow.
2. Faites glisser un déclencheur manuel sur la zone de dessin.

2. Ajouter et configurer le nœud de demande HTTP

1. Faites glisser un nœud de requête HTTP sur la zone de dessin et connectez-le au déclencheur.
2. Dans le panneau de configuration :
   • Définissez la méthode sur le verbe approprié (GET, POST, PUT, PATCH, ou DELETE).
   • Entrez l'URL complète du point de terminaison.
   • Sous En-têtes, ajoutez l'authentification et les en-têtes de type de contenu.

Pour l'authentification de la clé d'API :

Ajoutez un en-tête avec la clé Authorization et la valeur Bearer {{ secret.apiKey }}. Le préfixe secret. indique à Flow de rechercher la valeur dans votre magasin de variables sécurisé - ne collez jamais la clé directement dans le champ.

Pour l'authentification de base :

Ajoutez un en-tête avec la clé Authorization et la valeur Basic {{ secret.encodedCredentials }}, où encodedCredentials est la chaîne username:password encodée en base64.

3. Extraire les données dont vous avez besoin

1. Faites glisser un nœud Transformation de données sur la zone de dessin et connectez-le au nœud de demande HTTP.
2. Dans le panneau de configuration, mappez les champs de réponse dont vous avez besoin provenant de $vars.httpRequest1.output.body aux variables de sortie nommées.

Par exemple, pour extraire le nom et l'e-mail d'un utilisateur d'une réponse telle que { "user": { "name": "Alex", "email": "[e-mail]" } }, mappez :

• $vars.httpRequest1.output.body.user.name → userName
• $vars.httpRequest1.output.body.user.email → userEmail

4. Ajouter une gestion des erreurs

1. Sélectionnez le nœud de demande HTTP.
2. Faites glisser à partir de son handle d'erreur (le connecteur en bas à droite) vers un nouveau nœud Script.
3. Dans le nœud Script, journalisez l'erreur à partir de $vars.httpRequest1.error :

const error = $vars.httpRequest1.error;
console.log('API call failed:', error.message, '| Status:', error.status);
return null;

5. Test et débogage

Sélectionnez Test. Dans la trace d'exécution :

• Vérifiez la sortie statusCode du nœud de demande HTTP. 200 signifie succès ; 401 signifie que votre authentification est incorrecte ; 404 signifie que l'URL est incorrecte.
• Vérifiez la sortie du nœud Transformation de données pour confirmer que les champs ont été correctement extraits.
• Pour tester le chemin d'erreur, définissez temporairement l'URL sur une valeur non valide et vérifiez que le chemin d'erreur s'exécute.

Résultat

Votre workflow appelle l'API REST, extrait les champs dont vous avez besoin de la réponse et enregistre les échecs sur le chemin d'erreur. Vous pouvez inspecter le code de statut HTTP et les valeurs extraites dans la trace d'exécution et confirmer que les chemins de succès et d'erreur fonctionnent comme prévu.

Étendre ce workflow

• Gérer la pagination : si l'API renvoie des résultats sur plusieurs pages, ajoutez des nœuds de demande HTTP de suivi pour récupérer des pages supplémentaires, en vous basant sur une décision indiquant si la réponse inclut un curseur de page suivante.
• Écrivez les résultats dans un autre système : après le nœud Transformation de données, ajoutez un autre nœud de demande HTTP ou un nœud d'intégration pour envoyer les données en aval.
• Planifiez-le : remplacez le déclencheur manuel par un déclencheur planifié pour exécuter le workflow à un intervalle régulier.