Service Web REST package
- Dernière mise à jour2025/01/09
Service Web REST package
Utilisez les actions dans le Service Web REST package en tant que méthodes (DELETE, GET, PATCH, POST ou PUT) pour envoyer des demandes à une API et recevoir ses réponses.
Utilisation des Service Web REST actions
- Entrez l\'URI: adresse unique pour une ressource API.
-
Configuration du proxy : Pour définir le proxy, sélectionnez l\'option Système ou Personnalisé dans l\'onglet Configuration du proxy.
Option Description Système Le proxy système est le proxy configuré sur la machine d\'exécution de robot où le robot s\'exécute.
Si cette option est sélectionnée, le Bot Agent utilise le proxy système.Personnalisé Cette option vous permet de configurer des paramètres de proxy personnalisés au sein du actions de Service Web REST. Par exemple, si une API REST doit être acheminée par un proxy différent du proxy système, vous pouvez sélectionner l\'option Personnalisé et fournir les détails du proxy dans l\' REST actions.
Renseignez les détails suivants :
- Hôte : Le nom d\'hôte ou l\'adresse IP du proxy
- Port : Le numéro de port du proxy
- Nom d\'utilisateur (facultatif) : Le nom d\'utilisateur utilisé pour l\'authentification du proxy
-
Mot de passe (facultatif) : Le mot de passe utilisé pour l\'authentification du proxyRemarque : Si le proxy à configurer est un proxy authentifié, vous devez alors fournir les informations d\'authentification dans les champs Username et Password.
Pour les champs Hôte, Port, Nom d\'utilisateur et Mot de passe, choisissez parmi les onglets Information d\'identification, Variable ou Chaîne non sécurisée :- Informations d\'identification : Utilisez une valeur disponible dans le coffre d\'accréditation.
- Variable: Utilisez une variable qui stocke une valeur d\'information d\'identification dans une variable définie par l\'utilisateur.
- Chaîne non sécurisée : Spécifiez manuellement la valeur que vous souhaitez utiliser.
-
Mode d\'authentification : Il y a trois modes d\'authentification pris en charge :
- Aucune authentification : Utilisez cette option pour accéder aux points de terminaison qui ne nécessitent pas d\'authentification pour accéder à leurs serveurs.
- Jeton utilisateur de la Control Room : Les Service Web REST actions utilisent le jeton généré lors de la connexion à la Control Room pour accéder aux points de terminaison.
- Basique: Basique est la manière la plus simple d\'authentifier les utilisateurs. Lorsque vous sélectionnez cette option, vous devez saisir le nom d\'utilisateur et le mot de passe. Cette technique utilise un en-tête appelé Autorisation, où est saisie une représentation codée en base64 du nom d\'utilisateur et du mot de passe.
- Utilisateur AD connecté : Les utilisateurs d\'Active Directory (AD) qui sont autorisés à accéder à l\'API concernée sont authentifiés via AD. Aucune information d\'identification n\'est nécessaire dans la demande.
- Authentification NTLM (NT LAN Manager) de Windows (utilisateur AD) : une méthode d\'authentification de défi/réponse qui permet aux clients de fournir leur nom d\'utilisateur et leur mot de passe comme informations d\'identification chiffrées ou texte brut. Nous recommandons d\'utiliser les informations d\'identification stockées dans le Automation Anywhere Credential Vault.
-
Gestion OAuth2 - Control Room : Lorsque vous intégrez OAuth à la Control Room, vous pouvez gérer de manière centralisée et stocker en toute sécurité les jetons utilisés pour authentifier auprès de fournisseurs tiers. Vous devez configurer le service Web et noter les détails de l\'authentification (tels que l\'identifiant client, le secret du client, l\'URL d\'autorisation, etc.) pour utiliser la connexion OAuth dans la Control Room. Pour plus d\'informations, consultez Configurer les connexions OAuth dans la Control Room.
La vidéo suivante présente l\'utilisation de la connexion OAuth dans Service Web REST :
- En-tête : les méthodes ne nécessitent pas toutes un en-tête. Les en-têtes représentent les métadonnées associées à la demande.
-
Type de contenu : lorsqu\'un en-tête contient un type de contenu, il définit la négociation de contenu entre le client et le serveur. Service Web REST
actions prennent en charge les types de contenu suivants :
-
application/x-www-form-urlencoded
: Encodez les paramètres dans l\'URL. -
JSON (application/json)
: Saisissez un corps de requête JSON. -
XML (application/xml)
: Saisissez un corps de requête XML. -
Texte (texte/plain)
-
XML (text/xml)
-
HTML (text/html)
-
multipart/form-data
:- Envoyez des données binaires, dans la plupart des cas pour télécharger des Fichiers sur le serveur. Cela est utilisé dans les cas où vous envoyez plusieurs parties dans une seule demande, y compris généralement des données textuelles (comme des champs de formulaire) et potentiellement un chargement de fichier. Vous pouvez également utiliser une variable FileStream. Pour plus de détails, voir ci-dessous.
- Flux de fichiers Le FileStream peut être lu après l\'avoir assigné à une variable. Par exemple, vous pouvez lire un FileStream assigné à une variable dans un emplacement OneDrive. Pour plus d\'informations, consultez action Attribuer un fichier.
- Binaire: Utilisez Binary pour envoyer des fichiers bruts tels que des images, des vidéos et des fichiers audio. Lorsque vous sélectionnez Binary, vous pourrez télécharger un fichier binaire (en tant que variable, Control Room fichier ou fichier de bureau).
-
Personnalisé
Personnalisé
: Ajoutez un contenu personnalisé qui n\'entre pas dans le cadre du type de contenu standard. Par exemple, lors de la migration de la v.11.x vers Automation 360, la valeur suivante ne correspond à aucun des types de contenu standard : application/vnd.whispir.message-v1+json
-
-
Ajouter un
remplacement : Vous permet de saisir des variables dans le REST
corps de la demande. Une variable est une représentation symbolique de données, et elle
vous permet d\'accéder à une valeur sans avoir à la saisir manuellement
dès que vous en avez besoin. Par exemple, considérez le corps REST suivant
demande :
Dans le corps de la requête ci-dessus, vous pouvez remplacer les variables contenues dans des doubles accolades en cliquant sur Ajouter un remplacement et en ajoutant les valeurs requises.{ "name":"{{name}}", "email":"{{email}}", "status":"Active" }
-
Options avancées :
- Échec de la capture réponse : Cochez la case pour capturer l\'échec réponse sauf pour la Succès/Ok réponse. L\'échec Les détails de la réponse sont capturés dans le corps de la réponse.
- Autoriser les connexions non sécurisées lors de l\'utilisation de https : Sélectionnez le case à cocher pour autoriser les connexions non sécurisées lorsque vous utilisez https.
-
Accepter
Cookies: Cochez la case pour capturer automatiquement
cookies de session des réponses du serveur.
- Capturer : lorsqu\'elle est activée, cette fonction capture les cookies de session inclus dans les réponses du serveur.
- Stockage sécurisé: Les cookies capturés sont chiffrés dans le processus mémoire, garantissant qu\'elles ne sont jamais stockées de manière permanente et sont inaccessible en dehors de votre session d\'automatisation.
- Réutiliser: Les cookies sont automatiquement inclus dans les requêtes REST suivantes appels, éliminant la gestion manuelle des cookies et améliorant l\'automatisation fiabilité.
- Gestion de cookies multiples: La fonctionnalité gère sans heurt plusieurs cookies retournés par le serveur, garantissant tous les nécessaires les informations d\'identification d\'authentification sont incluses.
- Destruction : Les cookies capturés sont automatiquement détruits lorsque la session d\'automatisation se termine ou le robot finit l\'exécution, assurant sécurité des données et confidentialité.
Remarque : Les cookies capturés sont spécifiques à la domaine d\'origine et ne seront pas automatiquement utilisés pour appels REST subséquents effectués vers différents domaines. Cela signifie des cookies capturé depuisdomainA.com
ne sera pas utilisé pour demandes àdomainB.com
. -
Télécharger le fichier: (Seulement
disponible avec la méthode Get) Cochez cette case pour télécharger le fichier sur
un emplacement spécifique. L\'URI doit renvoyer/télécharger un fichier. Entrez le souhaité
chemin du dossier et nom de fichier avec extension. Assurez-vous d\'utiliser le bon fichier
extension. Par exemple : C:/Users/Downloads/image01.jpg
Conseil : Marquez le Écraser le fichier si existe déjà option pour écraser un fichier portant le même nom qui existe déjà dans le dossier dans lequel vous enregistrez le fichier à.Gestion des erreurs :
- URI non valide :
- Si l\'URI fournie est incorrecte, un message d\'erreur sera affiché.
- Fichier introuvable :
- Si la réponse de l\'API est vide parce que le fichier n\'existe pas à l\'emplacement spécifié, un message d\'erreur s\'affichera.
- Autorisations insuffisantes :
- Si vous n\'avez pas les autorisations d\'écriture pour l\'emplacement de téléchargement, un message d\'erreur s\'affichera.
- Incompatibilité d\'extension de fichier :
- Si l\'extension de fichier ne correspond pas au type attendu, un un message d\'erreur s\'affichera.
- Attendre que l\'action soit terminée : Vous pouvez définir un délai d\'expiration lorsque vous envoyez une requête REST et recevez une réponse. Lors de l\'exécution d\'actions telles que POST, PUT, DELETE, PATCH et GET, dans le champ Attendre que l\'action soit terminée, vous pouvez spécifier le temps d\'attente (en millisecondes). Par défaut, le temps d\'attente est de 60000 millisecondes.
-
Variable de sortie: la sortie de réponse est capturée dans une
variable de dictionnaire. Une variable de dictionnaire est une paire clé-valeur. Utilisez le
nom de l\'en-tête de la réponse en tant que clé pour renvoyer la valeur d\'en-tête, ou « Corps » en tant que clé
pour renvoyer le corps de la réponse.Remarque : La clé de réponse avec sa valeur est disponible dans la variable de dictionnaire pour afficher le statut de réponse de l\'API REST.Pour obtenir une liste des noms d\'en-tête pour la ressource API, procédez comme suit :
- Insérer un(e) Boucle action après le Service Web REST action.
- Sélectionnez Pour chaque clé du dictionnaire. itérateur.
- Dans le champ Variable de dictionnaire, sélectionnez la variable qui contient la sortie de Service Web REST Sortie du action.
- Attribuer la valeur de chaque clé à
$prompt-assignment$
. - Insérer un(e) Enregistrer dans un fichier action.
- Fournissez le chemin d\'accès à un fichier texte qui contiendra la liste des en-têtes. noms.
- Insérez
$prompt-assignment$
dans le champ Entrer le texte à consigner. - Sélectionnez l\'option Écraser le fichier existant .
- Cliquez sur Enregistrer.
Lorsque vous exécutez le robot, il imprime les noms d\'en-tête à partir de la ressource API dans le fichier sélectionné.
Transmettre des valeurs en toute sécurité
- URI
- En-têtes personnalisés
- Corps: Pour le type de contenu
application/x-www-form-urlencoded
, cliquez sur Ajouter un paramètre pour sélectionner la valeur de Credential Vault.Pour tous les autres types de contenu, sélectionnez le l\'option Choisir le paramètre d\'identification et cliquez Choisir.
Actions dans le Service Web REST package
Prise en charge du proxy
Si votre périphérique est configuré pour utiliser un proxy, toutes les demandes sortantes à partir de ce package sont acheminées via le serveur proxy. Reportez-vous à la rubrique Connecter l'Bot Agent à un périphérique avec un proxy.