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

Fournissez les informations suivantes pour envoyer une demande REST et recevoir une réponse. Tous les paramètres ne sont pas requis pour toutes les méthodes.
  • Entrer 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 Agent de robot utilise le proxy système.
    Personnalisé

    Cette option vous permet de configurer des paramètres de proxy personnalisés au sein des 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\'actions REST.

    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 proxy
      Remarque : Si le proxy à configurer est un proxy authentifié, vous devez fournir des informations d\'authentification dans les champs Nom d\'utilisateur et Mot de passe.
    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 :
    • Information d\'identification : Utilisez une valeur disponible dans le coffre des informations d\'identification.
    • 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 : trois modes d\'authentification sont 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 Active Directory (AD) autorisés à accéder à l\'API associé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 l\'authentification 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\'activation 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.
      • FileStream : Le FileStream peut être lu après l\'avoir affecté à une variable. Par exemple, vous pouvez lire un FileStream attribué à une variable dans un emplacement OneDrive. Pour plus d\'informations, consultez action Attribuer un fichier.FileStream des services Web REST
    • 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 pouvez charger un fichier binaire (en tant que variable, fichier Control Room 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 corps de requête REST. 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. Les détails de la réponse à l\'échec sont capturés dans le corps de la réponse.
    • 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 https.
    • Accepter les cookies : Cochez la case pour capturer automatiquement les cookies de session dans les 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 la mémoire du processus, ce qui garantit qu\'ils ne sont jamais stockés de manière permanente et qu\'ils sont inaccessibles en dehors de votre session d\'automatisation.
      • Réutilisation : les cookies sont automatiquement inclus 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 : cette fonctionnalité gère de manière transparente les cookies multiples renvoyés par le serveur, en veillant à ce que toutes les informations d\'authentification nécessaires soient incluses.
      • Destruction : les cookies capturés sont automatiquement détruits lorsque la session d\'automatisation se termine ou que le robot termine son exécution, ce qui garantit la sécurité et la confidentialité des données.
      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.
  • 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 telles que POST, PUT, DELETE, PATCH et GET, dans la section Attendre que l\'action se termine, vous pouvez spécifier le temps d\'attente (en millisecondes). Par défaut, le temps d\'attente est de 60 000 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 capturer la valeur d\'en-tête, ou « Corps » en tant que clé pour capturer le corps de la réponse.
    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 Boucle action après l\'Service Web REST 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\'Service Web REST action.
    4. Attribuez la valeur de chaque clé à $prompt-assignment$.
    5. Insérez une Enregistrer 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 robot, il imprime les noms d\'en-tête de la ressource API dans le fichier sélectionné.

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 consigne, 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 Service Web REST 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 :

  • Longueur de l\'URI limitée à 2 048 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.

Reportez-vous à la rubrique 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.

Reportez-vous à la rubrique 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. Reportez-vous à la rubrique Utilisation de la méthode Put.

Prise en charge du proxy

Si votre périphérique est configuré pour utiliser un proxy, toutes les demandes sortantes à partir du package sont acheminées via le serveur proxy. Reportez-vous à la rubrique Connecter l'Agent de robot à un périphérique avec un proxy.