Lire et examiner la documentation Automation Anywhere

Automation Anywhere Automation 360

Fermer les contenus

Contenus

Ouvrir les contenus

REST Web Service package

  • Mis à jour le : 2022/02/20
    • Automation 360 v.x
    • Créer
    • Espace de travail RPA

REST Web Service package

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

Utilisation des actions REST Web Service

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.
  • URI : adresse unique pour une ressource API.
  • Mode d'authentification : trois modes d'authentification sont pris en charge :
    • Basique : des chaînes de texte peuvent être utilisées pour l'authentification de base.
    • 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 Credential Vault Automation Anywhere.
  • 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.
    Remarque : Pour utiliser une clé API dans votre demande, saisissez api_key dans le champ d'en-tête Nom, et la valeur de la clé dans le champ Valeur.
  • 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.
  • 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. Les actions REST Web Service prennent en charge les types de contenu suivants :
    • application/json
    • application/xml
    • text/plain
    • text/html
    • text/xml
    • multipart/form-data
  • 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 action Loop après l'action REST Web Service.
    2. Sélectionnez l'itérateur Pour chaque clé du dictionnaire.
    3. Dans le champ Variable de dictionnaire, sélectionnez la variable qui contient la sortie de l'action REST Web Service.
    4. Attribuez la valeur de chaque clé à $prompt-assignment$.
    5. Insérez une action Log To File.
    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é.

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 package REST Web Service

Action Description
Méthode Delete 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.
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.
Méthode Put Met à jour une ressource en fonction des paramètres transmis dans l'URI ou le corps.

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'Bot agent à un périphérique avec un proxy.

Envoyer le commentaire