REST Web Services package

Utilisez les actions dans le REST Web Services package en tant que méthodes (DELETE, GET, PATCH, POST ou PUT) pour envoyer des demandes à une API et recevoir ses réponses.

Paramètres

Les paramètres suivants sont disponibles pour les REST Web Services actions. Configurez les paramètres appropriés pour envoyer une requête REST et recevoir une réponse. Chaque méthode nécessite des paramètres spécifiques.

Remarque : Lorsque vous créez des automatisations sur la plateforme macOS et utilisez des actions telles que (DELETE, GET, PATCH, POST ou PUT), les modes d\'authentification suivants ne sont pas pris en charge :
  • Authentification NTLM (Utilisateur AD)
  • Utilisateur AD connecté
URI
Saisissez l\'URI de la ressource API. Sélectionnez l\'une des options suivantes et configurez les paramètres en conséquence :
  • Entrez l\'URI: Saisissez l\'URI directement ou sélectionnez l\'URI enregistré comme variable de chaîne.
  • Sélectionner l\'identifiant comme URI : Utilisez cette option pour sélectionner un URI qui est enregistré comme identifiant dans le Credential Vault. Utilisez Identifiant > Choisir pour sélectionner directement l\'identifiant. Vous pouvez également utiliser l\'option Variable pour sélectionner un identifiant qui est associé à une variable d\'identifiant. Cette option vous permet de masquer les URI contenant des informations sensibles, telles que des codes d\'autorisation ou des clés API.
Configuration de proxy
Configurer les paramètres de proxy pour les actions REST Web Services. Sélectionnez l\'une des options suivantes et configurez les paramètres en conséquence :
  • Système : Sélectionnez cette option pour permettre à l\'Bot Agent d\'utiliser le proxy système. Le proxy système est le proxy que vous configurez sur la machine d\'exécution du bot, où l\'automatisation s\'exécute.
  • Personnalisé : Sélectionnez cette option pour configurer des paramètres de proxy personnalisés pour l\'automatisation. Configurez les paramètres suivants :
    • Hôte : nom d\'hôte ou adresse IP du serveur proxy.
    • Port: numéro de port du serveur proxy.
    • Nom d\'utilisateur (facultatif) : nom d\'utilisateur pour authentification du serveur proxy.
    • Mot de passe (facultatif) : mot de passe pour authentification du serveur proxy.
    Remarque : Vous devez configurer le Nom d\'utilisateur et le Mot de passe pour tout serveur proxy authentifié.
    Vous pouvez utiliser l\'une des options Identifiant, Variable ou Chaîne non sécurisée pour configurer les paramètres de proxy.
    • Informations d\'identification : pour sélectionner une valeur disponible dans le Credential Vault.
    • Variable : pour sélectionner la variable d\'identifiant qui est mappée à une valeur.
    • Chaîne non sécurisée : pour saisir la valeur manuellement ou sélectionner une valeur qui est mappée à une variable de chaîne prédéfinie.
Mode d\'authentification
Configurer les paramètres d\'authentification pour les actions REST Web Services. Sélectionnez l\'une des options suivantes et configurez les paramètres en conséquence :
  • Aucune authentification : sélectionnez 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 : sélectionnez cette option pour utiliser le jeton généré lorsque vous vous connectez à la Control Room.
  • Basique : sélectionnez cette option pour saisir le Nom d\'utilisateur et le Mot de passe pour authentifier les appels API REST Web Services. Cette option ajoute un en-tête nommé Autorisation qui contient une représentation sous forme de chaîne codée en base64 du Nom d\'utilisateur et du Mot de passe à l\'appel API.
  • Utilisateur AD connecté : sélectionnez cette option pour choisir l\'authentification basée sur Active Directory (AD). Les utilisateurs AD qui sont autorisés à accéder à l\'API associée sont authentifiés à l\'aide d\'AD. Aucune information d\'identification n\'est nécessaire dans la demande.
  • Authentification NTLM (NT LAN Manager) de Windows (utilisateur AD) : sélectionnez cette option pour choisir une authentification NTLM par défi-réponse. Configurez les paramètres suivants :
    • Domaine : saisissez le domaine dans lequel l\'appel API doit être authentifié. Vous pouvez également sélectionner une variable de chaîne mappée au domaine ou à l\'hôte.
    • Nom d\'utilisateur (facultatif) : nom d\'utilisateur pour authentification de l\'appel API.
    • Mot de passe (facultatif) : mot de passe pour authentification de l\'appel API.
    Vous pouvez utiliser l\'une des options Identifiant, Variable ou Chaîne non sécurisée pour configurer le nom d\'utilisateur et le mot de passe. Nous vous recommandons soit d\'utiliser l\'option Identifiant pour choisir un identifiant depuis le Credential Vault, soit d\'utiliser une variable d\'identifiant.
  • Gestion OAuth2 - Control Room : Sélectionnez cette option pour choisir une connexion Control Room managée OAuth par la comme option d\'authentification. Pour plus d\'informations, voir Configure OAuth connections in Control Room.

    La vidéo suivante présente l\'utilisation de la connexion OAuth dans REST Web Services :

En-tête
Ajoutez des en-têtes personnalisés pour inclure des métadonnées supplémentaires dans les requêtes API. les méthodes ne nécessitent pas toutes un en-tête. Vous pouvez ajouter des en-têtes comme Authorization, Accept-Charset, Content-Type, Cache-Control, User-Agent, etc.

Cliquez sur Ajouter un en-tête, puis suivez les instructions dans la fenêtre modale En-tête personnalisé pour ajouter les en-têtes requis. Vous pouvez sélectionner un identifiant stocké dans le Credential Vault ou une variable d\'identifiant, ou saisir directement l\'en-tête comme une chaîne non sécurisée.

Type de contenu
L\'en-tête Type de contenu définit le type de média du contenu dans le corps de la requête. Les REST Web Services actions prennent en charge les types de contenu suivants :
  • application/x-www-form-urlencoded : encode les paramètres au format de chaîne de requête URL.
  • JSON (application/json): saisissez un corps de requête au format JSON.
  • XML (application/xml) : saisissez un corps de requête au format XML.
  • Texte (text/plain) saisissez un corps de requête de type texte au format texte brut.
  • XML (text/xml) : saisissez un corps de requête de type texte au format XML.
  • HTML (text/html) saisissez un corps de requête de type texte au format HTML.
  • multipart/form-data: permet d\'inclure à la fois du texte et des fichiers dans le corps de la requête. Ce type de contenu prend en charge tous les formats de fichier que l\'API prend en charge. Vous pouvez utiliser ce type de contenu pour envoyer plusieurs parties dans une seule requête, incluant généralement des données textuelles (comme des champs de formulaire) et potentiellement un chargement de fichier. Ce type de contenu prend également en charge le streaming de fichier.
    Un flux de fichier peut être lu après l\'avoir affecté à une variable de type fichier. Par exemple, vous pouvez lire un flux de fichier affecté à une variable dans un emplacement OneDrive. Pour plus d\'informations, consultez action Attribuer un fichier.
    Services Web REST FileStream
  • Binaire: Utilisez Binary pour envoyer des fichiers bruts tels que des images, des vidéos et des fichiers audio. Vous pouvez charger des fichiers en utilisant l\'une des options suivantes :
    • Variable : affectez une variable de fichier pour charger un fichier depuis le bureau ou depuis la Control Room. Vous pouvez également utiliser cette option pour diffuser des fichiers depuis un emplacement de stockage.
    • Fichier de la Control Room : chargez un fichier disponible dans le stockage de la Control Room.
    • Fichier de bureau : chargez un fichier directement depuis votre 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

Pour application/x-www-form-urlencoded et multipart/form-data, cliquez sur Ajouter un paramètre et suivez les instructions dans le modèle Paramètre pour ajouter les paramètres d\'en-tête requis.

Pour d\'autres types de contenu, vous pouvez utiliser l\'option Saisir les paramètres ou l\'option Sélectionner l\'identifiant comme paramètres pour ajouter les paramètres. L\'option Sélectionner l\'identifiant comme paramètres vous permet d\'ajouter des données sensibles en tant qu\'en-têtes de requête.

Ajouter une substitution
L\'option Ajouter une substitution vous permet de saisir des variables dans le corps de la requête REST. Cette option est disponible pour les en-têtes de type de contenu JSON (application/json), XML (application/xml), Texte (text/plain), XML (text/xml), HTML (text/html), et Personnalisé .
Une variable est une représentation symbolique de données, et elle vous permet d\'accéder à une valeur sans avoir à la saisir manuellement partout où vous en avez besoin. Par exemple, considérez le corps de requête REST suivant :
{
   "name":"{{name}}",
   "email":"{{email}}",
   "status":"Active"
}
Dans le corps de requête ci-dessus, vous pouvez remplacer les variables insérées entre doubles accolades en cliquant sur Ajouter un remplacement et en ajoutant les valeurs requises.
Options avancées
Capturer la réponse à l\'échec : cochez cette case pour capturer la réponse à l\'échec, à l\'exception de la réponse Succès/Ok. Le système capture les détails de la réponse d\'échec dans le corps de la réponse. Cette option est disponible dans les actions des méthodes Delete, Get, Patch, Post et Put.
Autoriser les connexions non sécurisées lors de l\'utilisation de https : Cochez cette case pour autoriser une connexion non sécurisée lorsque vous utilisez le protocole https. Cette option est disponible dans toutes les actions.
Accepter les cookies : Cochez la case pour capturer automatiquement les cookies de session dans les réponses du serveur. Les fonctionnalités suivantes s\'activent en arrière-plan lorsque vous cochez cette case.
  • Capturer : Le système capture les cookies de session que le serveur inclut dans les réponses.
  • Stockage sécurisé: Le système chiffre les cookies capturés dans la mémoire du processus, garantissant qu\'ils ne sont jamais stockés de manière permanente et qu\'ils sont inaccessibles en dehors de votre session d\'automatisation.
  • Réutiliser: Le système inclut automatiquement les cookies dans les appels REST suivants, ce qui élimine la gestion manuelle des cookies et améliore la fiabilité de l\'automatisation.
  • Gestion de cookies multiples: Le système permet à l\'automatisation de gérer plusieurs cookies renvoyés par le serveur, en veillant à ce que tous les identifiants d\'authentification nécessaires soient inclus.
  • Destruction : Le système détruit automatiquement les cookies capturés lorsque la session d\'automatisation se termine ou que l\'exécution du robot se termine, garantissant la sécurité et la confidentialité des données.

Cette option est disponible dans les actions des méthodes Delete, Get, Patch, Post et Put.

Remarque : Les cookies capturés sont spécifiques au domaine dont ils proviennent et ne seront pas automatiquement utilisés pour les appels REST ultérieurs effectués dans des domaines différents. Cela signifie que les cookies capturés à partir de domainA.com ne seront pas utilisés pour les demandes vers domainB.com.
Télécharger le fichier: Cochez cette case pour télécharger le fichier binaire disponible dans l\'URI vers un emplacement spécifique. Assurez-vous d\'entrer le chemin de fichier souhaité avec le nom et l\'extension. Par exemple : <C:/Users/Downloads/image01.jpg>

Cette option n\'est disponible que dans l\'action de méthodde Get. Le système affiche un message d\'erreur lorsque l\'un des scénarios suivants se produit :

  • URI non valide : si l\'URI fourni est incorrect.
  • Fichier introuvable : si la réponse de l\'API est vide parce que le fichier n\'existe pas à l\'emplacement spécifié.
  • Autorisations insuffisantes : si vous n\'avez pas les autorisations d\'écriture pour l\'emplacement de téléchargement.
  • Incompatibilité d\'extension de fichier : si l\'extension de fichier ne correspond pas au type attendu.

Activez la case à cocher Écraser le fichier s\'il existe déjà pour écraser un fichier existant par une nouvelle version.

Attendre que l\'action se termine
vous pouvez définir un délai d\'expiration lorsque vous envoyez une demande REST et recevez une réponse. Lorsque vous effectuez des actions tels que POST, PUT, DELETE, PATCH et GET, spécifiez le temps d\'attente (en millisecondes) dans le champ Attendre que l\'action se termine. Par défaut, le temps d\'attente est de 60 000 millisecondes
Configuration SSL/TLS
Utilisez cette option pour télécharger un fichier de certificat avec ou sans mot de passe afin de fournir une authentification supplémentaire lors des appels API REST.

La configuration SSL/TLS utilise le protocole TLS mutuel (mTLS) pour chiffrer, authentifier et sécuriser les communications entre l\'URI de l\'API et le client. mTLS exige que les deux entités s\'authentifient mutuellement en échangeant des certificats. La transmission de données se produit uniquement si les deux entités authentifient avec succès les certificats échangés.

Le support REST Web Services les certificats de type .p12 pour les machines Windows et le format .pfx pour les machines non-Windows.

  • Chemin du fichier de magasin de clés (facultatif) : Téléchargez le fichier de certificat en utilisant l\'option Variable, fichier de la Control Room ou fichier de bureau.
  • Mot de passe du magasin de clés (facultatif) : Si le certificat est protégé par un mot de passe, vous pouvez authentifier le mot de passe du certificat en utilisant l\'option Credential, Variable ou Insecure string. Pour plus d\'informations sur le stockage sécurisé des mots de passe dans le casier Credential, consultez Informations d'identification et lockers dans le Credential Vault.
Attribuer la sortie à une variable
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 capturer la valeur d\'en-tête, ou « Corps » en tant que clé pour capturer le corps de la réponse.

Cette option est disponible dans les actions des méthodes Delete, Get, Patch, Post et Put.

Remarque : La clé de réponse avec sa valeur est disponible dans la variable de dictionnaire pour afficher l\'état de la réponse de l\'API Rest.
Pour obtenir une liste des noms d\'en-tête pour la ressource API, procédez comme suit :
  1. Insérez une Loop action après l\'REST Web Services action.
  2. Sélectionnez l\'itérateur Pour chaque clé du dictionnaire.
  3. Dans le champ Variable du dictionnaire, sélectionnez la variable qui contient la sortie de l\'REST Web Services action.
  4. Attribuez la valeur de chaque clé à $prompt-assignment$.
  5. Insérer un Enregistrer le texte dans un fichier action.
  6. Fournissez le chemin d\'accès à un fichier texte qui contiendra la liste des noms d\'en-tête.
  7. Insérez $prompt-assignment$ dans le champ Consigner dans un journal.
  8. Sélectionnez l\'option Remplacer le fichier existant.
  9. Cliquez sur Enregistrer.

    Lorsque vous exécutez le bot, il imprime les noms d\'en-tête de la ressource API dans le fichier sélectionné.

Affecter le fichier à une variable
Cette option n\'est disponible que dans l\'action Get file stream. L\'action Get file stream vous permet d\'affecter une variable de fichier au fichier disponible dans l\'URI. Vous pouvez ensuite utiliser cette variable de fichier dans toutes les actions suivantes de la session. Pour en savoir plus sur l\'attribution d\'une variable de fichier, voir Utilisation de l\'action Obtenir le flux de fichiers.

Transmettre des valeurs en toute sécurité

Vous pouvez transmettre en toute sécurité des valeurs du Credential Vault au service Web en spécifiant le locker, les informations d\'identification et l\'attribut dans les champs d\'action pris en charge suivants :
  • 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 dans le Credential Vault.

    Pour tous les autres types de contenu, sélectionnez l\'option Sélectionner les informations d\'identification en tant que paramètres et cliquez sur Choisir.

Actions du REST Web Services package

Action Description
Méthode Supprimer Supprime la ressource identifiée par l\'URI.
Méthode Get Récupère les informations identifiées par les paramètres inclus dans l\'URI. Il n\'y a pas de Type de contenu pour la méthode GET, car tous les paramètres sont transmis via l\'URI.

Les limitations et caractéristiques de la méthode GET comprennent :

  • La longueur de l\'URI est limitée à 2048 caractères.
  • Tous les paramètres sont transmis dans l\'URI.
  • La méthode GET expose les données qui se trouvent dans l\'URI, ce qui la rend moins sécurisée que la méthode POST.
  • GET ne modifie aucune donnée, ce qui la rend sûre pour tous les utilisateurs, quelle que soit l\'autorisation.

Voir Utilisation de la méthode Get.
Méthode de correctif Modifie la ressource identifiée par l\'URI.
Méthode Post Crée une nouvelle ressource dans l\'URI.
  • Les paramètres sont transmis dans le corps de la demande.
  • Il n\'y a pas de limite de longueur pour le corps de la demande.

Voir Utilisation de la méthode Post.
Méthode Put Met à jour une ressource en fonction des paramètres transmis dans l\'URI ou le corps. Voir Utilisation de la méthode Put.

Proxy support

If your device is configured with a proxy, all outbound requests from this package are routed through the proxy server. See Connecter l\'Bot Agent à un périphérique avec un proxy.