Appeler une API externe

Appelez une API de transfert d'état représentatif authentifié, gérez la réponse et extrayez les données pour les nœuds de workflow en aval.

Ce que vous allez créer: un workflow qui appelle une API de transfert d'état de représentation authentifiée, gère la réponse et met les données extraites à la disposition des nœuds en aval. Il s'agit de l'un des modèles les plus courants dans Flux - 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é API, jeton du porteur ou informations d’identification de base).

Nœuds utilisés

• Déclencheur manuel — le workflow démarre à la demande
• Requête HTTP — appelle l'API REST
• Transformation de données : extrait les champs dont vous avez besoin dans la réponse
• Script — enregistre les échecs sur le chemin d'erreur de la requête HTTP

Étapes

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

1. Ouvrez Maestro → Flow et créez un nouveau workflow.
2. Faites glisser une activité Manual Trigger vers le canevas.

2. Ajoutez et configurez le nœud de requête HTTP

1. Faites glisser un nœud de requête HTTP sur le canevas 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).
   • Saisissez l' URL complète du point de terminaison.
   • Sous En-têtes, ajoutez des en-têtes d’authentification et de type de contenu.

Pour l’authentification par clé 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 à partir de 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 de transformation de données sur le canevas et connectez-le au nœud de requête HTTP.
2. Dans le panneau de configuration, mappez les champs de réponse dont vous avez besoin depuis $vars.httpRequest1.output.body jusqu'aux variables de sortie nommées.

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

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

4. Ajouter la gestion des erreurs

1. Sélectionnez le nœud de requête HTTP.
2. Faites glisser de sa gestion des erreurs (le connecteur en bas à droite) vers un nouveau nœud Script .
3. Dans le nœud Script, consignez l'erreur de $vars.httpRequest1.error:

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

5. Tester et déboguer

Sélectionnez Test (Tester). Dans le Trace de l’exécution:

• Vérifiez la sortie statusCode du nœud de requête HTTP. 200 signifie réussite; 401 signifie que votre authentification est incorrecte; 404 signifie que l’URL est incorrecte.
• Vérifiez la sortie du nœud de la transformation de données pour confirmer que les champs ont été extraits correctement.
• 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 dans 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 réussite et d'Error 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 requête HTTP au suivi pour récupérer des pages supplémentaires, en se ramifiant avec une Décision indiquant si la réponse inclut un curseur à la page suivante.
• Écrire les résultats dans un autre système: après le nœud de la transformation de données, ajoutez un autre nœud de requête HTTP ou un nœud d’intégration pour transmettre les données en aval.
• Planifier: remplacez le Déclencheur manuel par un Déclencheur planifié pour exécuter le workflow à intervalle régulier.