- Introduction
- Démarrage
- Créer sur n’importe quel canevas
- Créer avec le cas
- Référence (Reference)
- Définition des clés de cas (système vs. externe)
- Établissement des contrats d'E/S et de réécriture de la tâche
- Modélisation des étapes primaires et secondaires
- Déclencher un cas à partir de Data Fabric
- Implémentation des personas et des autorisations au niveau de l'étape
- Définition des SLA et des règles d'escalade automatisées
- Configuration d'une boucle de retraitement (renouvellement)
- Configurer et tester l'agent Case Manager (aperçu)
- Créer avec Flow
- Créer avec BPMN
- Opérations
- Surveillance
- Optimisation
- Informations de référence
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
- A UiPath Automation Cloud account with access to 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
- Transform — extracts the fields you need from the response
- Script — returns the error details on the HTTP Request's error path
Étapes
1. Créer un nouveau Flow et ajouter un déclencheur
- Open Maestro Orchestrate → Flow and create a new workflow.
- Faites glisser un déclencheur manuel sur la zone de dessin.
2. Ajouter et configurer le nœud de demande HTTP
- Faites glisser un nœud de requête HTTP sur la zone de dessin et connectez-le au déclencheur.
- Dans le panneau de configuration :
- Définissez la méthode sur le verbe approprié (
GET,POST,PUT,PATCH, ouDELETE). - 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.
- Définissez la méthode sur le verbe approprié (
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
- Faites glisser un nœud Transformation de données sur la zone de dessin et connectez-le au nœud de demande HTTP.
- Dans le panneau de configuration, mappez les champs de réponse dont vous avez besoin provenant de
$vars.httpRequest1.output.bodyaux 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": "alex@example.com" } }, mappez :
$vars.httpRequest1.output.body.user.name→userName$vars.httpRequest1.output.body.user.email→userEmail
4. Ajouter une gestion des erreurs
- Sélectionnez le nœud de la requête HTTP, ouvrez l'onglet Gestion des erreurs et activez Activer la gestion des erreurs. Une gestion des erreurs apparaît sous la gestion de la sortie principale.
- Sélectionnez + dans la gestion des erreurs , recherchez Script et sélectionnez-le.
- In the Script node, return the error details from
$vars.httpRequest1.error. The returned message appears in the execution trace:
const error = $vars.httpRequest1.error;
return {
message: "Error raised: " + error.message,
status: error.status
};
const error = $vars.httpRequest1.error;
return {
message: "Error raised: " + error.message,
status: error.status
};
5. Test et débogage
Sélectionnez Test. Dans la trace d'exécution :
- Vérifiez la sortie
statusCodedu nœud de demande HTTP.200signifie succès ;401signifie que votre authentification est incorrecte ;404signifie 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
Your workflow calls the REST API, extracts the fields you need from the response, and returns the error details on the error path. You can inspect the HTTP status code and extracted values in the execution trace, and confirm both the success and error paths work as expected.
É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.