Demande HTTP (HTTP Request)

UiPath.WebAPI.Activities.HttpClient

Description

Permet d'effectuer des requêtes HTTP vers une API Web spécifiée. Lorsque vous faites d'abord glisser cette activité vers le panneau Concepteur (Designer), la fenêtre Assistant de requête HTTP (HTTP Request Wizard) s'affiche, ce qui facilite la création de requêtes et la prévisualisation des réponses du serveur.

Remarque : si le code d'état HTTP renvoyé (StatusCode) est 0, cela signifie que le serveur n'a pas renvoyé de réponse réelle pour une raison quelconque. Cela indique généralement des problèmes de connectivité ou de réseau que vous pourriez rencontrer.

Attention : le package WebAPI n'est pas compatible avec les activités suivantes : UiPath.Salesforce.Activities et UiPath.Jira.Activities.

Compatibilité du projet

Windows - Héritage | Windows | Multiplate-forme

Configuration multiplateforme

• Méthode de requête : la méthode de requête à utiliser lors de l'appel de l'API. Les verbes HTTP suivants sont pris en charge : GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH, et MERGE. La méthode GET est sélectionnée par défaut.
• URL de la demande : URL vers laquelle vous souhaitez envoyer la demande. Les segments personnalisés doivent être placés entre crochets "{}" et définis dans la section Paramètres (Parameters). Par exemple, cette URL https://platform.uipath.com/odata/Robots(28) peut être écrite sous la forme https://platform.uipath.com/odata/Robots{id}, et la valeur du paramètre id peut être indiquée dans la fenêtre SegmentsURL.
• Paramètres : les paramètres de la requête. Cliquez sur le champ pour ouvrir la fenêtre Dictionnaire .
• En-têtes : permet d'inclure des en-têtes personnalisés dans la requête HTTP. Cliquez sur le champ pour ouvrir la fenêtre Dictionnaire .
• Corps (Body) - Corps de la requête.
• Authentification (Authentication) - Spécifie le protocole d'authentification à utiliser lors de l'appel de l'API. Les protocoles suivants sont pris en charge :
  • None (Aucun) - Option par défaut. Elle doit être utilisée si le serveur Web auquel vous envoyez des requêtes ne nécessite pas de protocole d'authentification.
  • Simple Http (HTTP simple) - Cette option doit être sélectionnée si l'API vers laquelle vous faites une demande utilise un simple protocole d'authentification HTTP. Si vous choisissez cette option, deux champs supplémentaires sont affichés : Nom d'utilisateur (Username) et Mot de passe (Password), qui doivent être renseignés avec des informations d'identification valides pour l'API spécifiée.
  • OAuth1 : cette option doit être sélectionnée si l'API vers laquelle vous effectuez des requêtes utilise un protocole OAuth1. Si vous choisissez cette option, quatre champs supplémentaires s'affichent : Consumer Key, Consumer Secret, Access Token, Access Token Secret.
  • OAuth2 (OAuth2) - Cette option doit être sélectionnée si l'API vers laquelle vous faites une requête utilise un protocole OAuth2. Si vous choisissez cette option, le champ Jeton d'accès (Access Token) s'affiche. Ce jeton d'accès est généralement généré en réponse à une autre requête HTTP adressée à l'API indiquée.
  • Certificat client - Cette option doit être sélectionnée si un certificat client est nécessaire pour effectuer l'appel de l'API. Si elle est choisie, deux champs supplémentaires s'affichent :
    • CertificatClient : chemin complet vers l'emplacement du fichier de certificat client. L'encodage de certificat pris en charge est X.509 et les extensions acceptées sont .pfx et .p12.
    • MotDePasseCertificatClient : mot de passe défini lors de l'exportation du fichier de certificat client.

Avancé

Options

• Timeout (millisecondes) : spécifie le délai d'attente (en millisecondes) pour l'exécution de l'activité avant qu'une erreur soit générée. La valeur par défaut est de 6000 millisecondes (6 secondes).
• Continuer en cas d'erreur (Continue on error) : précise si l’automatisation doit se poursuivre même si l’activité génère une erreur. Ce champ prend uniquement en charge les valeurs booléennes (Vrai (True), Faux (False)). La valeur par défaut est Faux (False). Par conséquent, si le champ n'est pas configuré et qu’une erreur est générée, l’exécution du projet s’arrête. Si le champ indique au contraire Vrai (True), l'exécution du projet se poursuit même en cas d'erreur.
• Vérification du certificat SSL : si cette option est sélectionnée, elle vérifie les certificats SSL lors de l'envoi d'une demande. Les échecs de vérification entraîneront l’abandon de la demande.
• Accepter le format ( Accept Format ) - Format dans lequel la réponse du serveur Web est reçue. Les options suivantes sont prises en charge : TOUT ( ANY ) - la valeur par défaut, XML, JSON et PERSONNALISÉ ( CUSTOM). Lors du choix de PERSONNALISÉ ( CUSTOM AcceptFormat), si un paramètre d'en-tête Accept ou accept est présent, il sera envoyé au format d'acceptation personnalisé. Si aucun paramètre d'en-tête n'est défini, accept obtiendra la valeur par défaut RestSharp :

  application/json, application/xml, text/json, text/x-json, text/javascript,
        text/xml

  .
• Pièces jointes au fichier (File Attachments ) : liste des pièces jointes de la demande.
• Nom de fichier de la pièce jointe de la réponse : le nom de fichier à utiliser pour le fichier renvoyé par la demande.
• FormatCorps : Format dans lequel doit être le corps. Par défaut, elle est renseignée avec application/xml. Ce champ ne prend en charge que les chaînes et les variables String.
• Cookies : les cookies de la requête HTTP. Cliquez sur le champ pour ouvrir la fenêtre Dictionnaire .
• Segments d'URL : segments personnalisés ajoutés à l'URL du point de terminaison entre accolades « {} ». Cliquez sur le champ pour ouvrir la fenêtre Dictionnaire . Par exemple, l'URL https://platform.uipath.com/odata/Robots(28) peut être écrite sous la forme https://platform.uipath.com/odata/Robots{id}et la valeur du paramètre id peut être fournie dans la fenêtre Dictionnaire . Ce champ prend en charge les chaînes et les variables de chaîne.

Sortie

• Contenu de la réponse : Réponse reçue de la requête HTTP en tant que variable de chaîne.
• Statut de la réponse : Code d'état reçu de la requête HTTP, en tant que variable entière.
• En-têtes de réponse : la réponse reçue de la requête HTTP.
• Pièce jointe de laréponse : la pièce jointe enregistrée à partir de la réponse.

Windows, Windows - Configuration héritée

Fenêtre Assistant d'importation (Import Wizard)

Vous pouvez l'utiliser pour importer une requête HTTP au format CURL.

Fenêtre de l'Assistant de requête HTTP

Tous les champs présents dans l'assistant sont également disponibles dans le panneau Propriétés (Properties). Par conséquent, vous pouvez toujours modifier vos préférences après la fermeture de l'assistant. Vous pouvez configurer l'activité dans l'assistant à l'aide de valeurs ou de variables codées en dur.

Remarque : lorsque des variables sont utilisées, la fonctionnalité d'aperçu n'est pas disponible.

Onglet Générateur de requête (Request Builder)

• Point de terminaison : URL vers laquelle vous souhaitez envoyer la demande. Les segments personnalisés doivent être placés entre crochets "{}" et définis dans la section Paramètres (Parameters). Par exemple, cette URL https://platform.uipath.com/odata/Robots(28) peut être écrite sous la forme https://platform.uipath.com/odata/Robots({id}), et la valeur du paramètre id peut être indiquée dans la fenêtre SegmentsURL.
• Aperçu de l'URL (Preview URL) - Aperçu de l'URL fournie dans le champ Point de terminaison (End point), en tenant compte des informations fournies dans la section Paramètres (Parameters).
• Activer la vérification du certificat SSL : cochez cette case pour vérifier les certificats SSL lors de l'envoi d'une requête. L'échec de la vérification entraîneront l'abandon de la requête.
• Délai d'expiration (Timeout) - Spécifie la durée (en millisecondes) d'attente d'exécution de l'activité avant la génération d'un message d'erreur. La valeur par défaut est 6 000 millisecondes (6 secondes).

• Certificat client (Client Certificate ) : l'emplacement dans lequel le fichier de certificat client est stocké. Le chemin complet doit être fourni.

  Remarque : Le chemin d'accès ne doit pas être écrit entre guillemets.
• Mot de passe du certificat de client (Client Certificate Password) : mot de passe qui correspond au fichier de certificat de client que vous utilisez.
• Méthode de requête : la méthode de requête à utiliser lors de l'appel de l'API. Les verbes HTTP suivants sont pris en charge : GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH, et MERGE. La méthode GET est sélectionnée par défaut.

• Authentification (Authentication) - Spécifie le protocole d'authentification à utiliser lors de l'appel de l'API. Les protocoles suivants sont pris en charge :

  • None (Aucun) - Option par défaut. Elle doit être utilisée si le serveur Web auquel vous envoyez des requêtes ne nécessite pas de protocole d'authentification.
  • Simple Http (HTTP simple) - Cette option doit être sélectionnée si l'API vers laquelle vous faites une demande utilise un simple protocole d'authentification HTTP. Si vous choisissez cette option, deux champs supplémentaires sont affichés : Nom d'utilisateur (Username) et Mot de passe (Password), qui doivent être renseignés avec des informations d'identification valides pour l'API spécifiée.
  • OAuth1 (OAuth1) - Cette option doit être sélectionnée si l'API vers laquelle vous effectuez des requêtes utilise un protocole OAuth1. Si vous choisissez cette option, quatre champs sont affichés : Clé de consommateur (Consumer Key) , Consumer Secret (Clé secrète), Jeton d'accès (Access Token), Clé de jeton d'accès (Access Token Secret).
  • OAuth2 (OAuth2) - Cette option doit être sélectionnée si l'API vers laquelle vous faites une requête utilise un protocole OAuth2. Si vous choisissez cette option, le champ Jeton d'accès (Access Token) s'affiche. Ce jeton d'accès est généralement généré en réponse à une autre requête HTTP adressée à l'API indiquée.

Section Paramètres

• Ajouter un paramètre (Add Parameter) - Ajoute une nouvelle ligne dans la table des paramètres, avec le type Obtenir ou diffuser (GetOrPost). Aucune nouvelle ligne n'est ajoutée si la ligne précédente n'est pas renseignée.

• Ajouter un en-tête (Add Header) - Ajoute une nouvelle ligne dans la table des paramètres avec le type En-tête Htt (HttpHeader). Aucune nouvelle ligne n'est ajoutée si la ligne précédente n'est pas renseignée.

  Remarque :Au cas où vous souhaiteriez ajouter plusieurs valeurs pour un en-tête, elles doivent être concaténées à l'aide d'une virgule (,).
• Ajouter un segment d'URL (Add URL Segment) - Ajoute une nouvelle ligne dans la table des paramètres avec le type URL du segment (UrlSegment). Aucune nouvelle ligne n'est ajoutée si la ligne précédente n'est pas renseignée.
• Supprimer (Delete) - Supprime une ligne sélectionnée dans la table Paramètres. Si une ligne n'est pas sélectionnée, ce bouton est désactivé.

Table des paramètres

• Nom (Name) - Nom du paramètre, de l'en-tête ou du segment d'URL.
• Valeur (Value) - Valeur du paramètre, de l'en-tête ou du segment d'URL.

• Type (Type) - Type de ligne. Les options suivantes sont disponibles :

  • Obtenir ou diffuser (GetOrPost) - indique que la ligne est un paramètre pouvant être utilisé dans les requêtes.
  • En-tête Htt (HttpHeader) - Indique que la ligne ajoutée dans la table Paramètres (Parameters) est un en-tête de requête à envoyer lors de l'appel de l'API.

  • UrlSegment : indique que la ligne ajoutée est un fragment ou l'URL fournie dans le champ Point de fin .

    Remarque :Dans certains cas, un message d'erreur peut être renvoyé indiquant que les paramètres doubles ne peuvent pas exister. Cela peut être dû à des requêtes d'authentification qui doivent contenir les paramètres Mot de passe (Password) et Nom d'utilisateur (Username). Dans ce cas, nous recommandons de les transmettre à l'aide de la propriété Corps (Body).

Section Pièces jointes (Attachments)

• Ajouter une pièce jointe (Add Attachment) : Permet d'ajouter un fichier à la requête HTTP effectuée en créant une nouvelle ligne. Option activée uniquement lorsque Méthode de requête (Request Method) est définie sur POST ou PUT.
• Supprimer la pièce jointe (Delete Attachment) - Permet de supprimer une ligne précédemment ajoutée dans la section Pièces jointes (Attachments).
• Nom (Name) - Nom du fichier que vous souhaitez joindre.
• Chemin du fichier (File Path) - Chemin complet du fichier que vous voulez joindre.
• Type : Indique le type d'informations que vous envoyez. Ce champ est automatiquement renseigné avec Pièce jointe. Aperçu - Vous permet d'afficher un aperçu de la requête HTTP que vous avez créée et ouvre l'onglet Réponse.

Onglet Réponse (Response)

Cet onglet permet de prévisualiser la requête à inclure dans votre workflow. Vous pouvez y accéder en cliquant sur le bouton Prévisualiser (Preview) dans l'assistant de requête HTTP, après avoir rempli tous les champs et avoir configuré la requête. Vous pouvez également modifier l'onglet dans la partie supérieure de l'assistant.

Cette page comprend les éléments suivants :

• Informations sur la requête (Request Info) - Cette section affiche des détails sur la requête effectuée. Elle affiche l'URL de la requête, la méthode et le code d'état.
• Aperçu de la réponse (Preview Response) - Affiche la réponse du serveur Web.
• Corps brut (Raw Body) - Affiche la réponse du serveur Web sous forme brute.
• Informations sur la réponse (Response Info) - Affiche des informations sur la réponse du serveur Web. Le statut et le code de la réponse (ainsi que l'en-tête content-type pris en charge) sont affichés.
• Télécharger les ressources (Download Resource) - Permet de télécharger les ressources demandées vers un fichier indiqué.
• Actualiser (Refresh) - Permet d'effectuer à nouveau la requête.

Panneau propriétés

Authentification du certificat client

• CertificatClient : chemin complet vers l'emplacement du fichier de certificat client. L'encodage de certificat pris en charge est X.509 et les extensions acceptées sont .pfx et .p12.
• MotDePasseCertificatClient : mot de passe défini lors de l'exportation du fichier de certificat client.
• Activer la vérification des certificats SSL : permet de vérifier les certificats SSL lors de l'envoi d'une demande. Les échecs de vérification entraîneront l’abandon de la demande. Ce champ prend uniquement en charge les valeurs booléennes (True, False).
• SecureClientCertificatePassword - Mot de passe du fichier de certificat client spécifié, sous la forme d'une chaîne sécurisée. Ce champ prend en charge uniquement les variables SecureString.

Commun

• Poursuite sur erreur (ContinueOnError) - Spécifie si l'automatisation doit continuer même si l'activité génère un message d'erreur. Ce champ prend uniquement en charge les valeurs booléennes (True, False). La valeur par défaut est False. Par conséquent, si le champ est vide et si une erreur est renvoyée, l'exécution du projet s'interrompt. Si la valeur est configurée sur True, l'exécution du projet continue indépendamment de toute erreur.

  Remarque : si cette activité est incluse dans l'activité Try Catch et que la valeur de la propriété ContinuerSurErreur est « True », aucune erreur ne sera détectée lors de l'exécution du projet.
• NomAffichage (DisplayName) - Nom affiché de l'activité.
• Timeout (millisecondes) : spécifie le délai d'attente (en millisecondes) pour l'exécution de l'activité avant qu'une erreur soit générée. La valeur par défaut est de 6000 millisecondes (6 secondes).

Entrée

• AcceptFormat : le format dans lequel recevoir la réponse du serveur Web. Les options suivantes sont prises en charge : ANY : la valeur par défaut, XML, JSONet CUSTOM. Lors du choix du CUSTOM AcceptFormat, si un paramètre d’en-tête Accept ou accept est présent, il sera envoyé en tant que format d’acceptation personnalisé. Si aucun paramètre d'en-tête n'est défini, accept obtiendra la valeur par défaut RestSharp : application/json, application/xml, text/json, text/x-json, text/javascript, text/xml.
• Méthode de requête : la méthode de requête à utiliser lors de l'appel de l'API. Les verbes HTTP suivants sont pris en charge : GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH, et MERGE. La méthode GET est sélectionnée par défaut.
  Remarque : la requête HTTP ne fonctionne correctement qu'avec la version 106.11.2 ou inférieure du package RestSharp. Il renvoie une erreur lorsque RestSharp version 106.11.4 ou supérieure est installée.
• URL de la demande : URL vers laquelle vous souhaitez envoyer la demande. Les segments personnalisés doivent être placés entre crochets "{}" et définis dans la section Paramètres (Parameters). Par exemple, cette URL https://platform.uipath.com/odata/Robots(28) peut être écrite sous la forme https://platform.uipath.com/odata/Robots{id}, et la valeur du paramètre id peut être indiquée dans la fenêtre SegmentsURL.

Divers

• Privé (Private) - Si cette option est sélectionnée, les valeurs des variables et des arguments ne sont plus enregistrées au niveau Détaillé (Verbose).

OAuth1

• Clé utilisateur (ConsumerKey) - Clé du consommateur à utiliser si l'API vers laquelle vous faites des requêtes est basée sur le protocole d'authentification OAuth1.
• Secret utilisateur (ConsumerSecret) - Clé secrète du consommateur à utiliser si l'API vers laquelle vous effectuez des requêtes est basée sur le protocole d'authentification OAuth1.
• OAuth1Token (OAuth1Token) - Jeton d'accès à utiliser si l'API vers laquelle vous effectuez des requêtes est basée sur le protocole d'authentification OAuth1, après l'approbation d'une requête d'autorisation pour le consommateur.
• OAuth1TokenSecret (OAuth1TokenSecret) - Clé secrète à utiliser si l'API vers laquelle vous effectuez des requêtes est basée sur le protocole d'authentification OAuth1, après l'approbation d'une requête d'autorisation pour le consommateur.

OAuth2

• OAuth2Token (OAuth2Token) - Jeton d'accès à utiliser si l'API vers laquelle vous effectuez des demandes est basée sur le protocole d'authentification OAuth2. Ce jeton d'accès est généralement généré en réponse à une autre requête HTTP adressée à l'API indiquée..

Options

• Pièces jointes (Attachments) - Permet de joindre des fichiers à des requêtes. Cliquez sur le bouton Ellipse (Ellipsis) pour ouvrir la fenêtre Pièces jointes (Attachements) et ajouter tous les fichiers requis.
• Corps (Body) - Corps de la requête.
• FormatCorps : Format dans lequel doit être le corps. Par défaut, elle est renseignée avec application/xml. Ce champ ne prend en charge que les chaînes et les variables String.
• Cookies : les cookies de la requête HTTP. Cliquez sur le bouton Points de suspension pour ouvrir la fenêtre Cookies .
• Pièces jointes : Liste des pièces à joindre à la demande.
• Nom de fichier de la pièce jointe de la réponse : le nom de fichier à utiliser pour le fichier renvoyé par la demande.
• En-têtes (Headers) - Permet d'inclure des en-têtes personnalisés dans la requête HTTP. Cliquez sur le bouton Ellipse (Ellipsis) pour ouvrir la fenêtre En-têtes (Headers).
• Paramètres (Parameters ) - Paramètres de la requête. Cliquez sur le bouton Ellipse pour ouvrir la fenêtre Paramètres , qui correspond à la section Paramètres.
• SegmentsURL : Segments personnalisés ajoutés à l'URL de point de terminaison entre crochets "{}". Cliquez sur le bouton Ellipse pour ouvrir la fenêtre segmentsURL. Par exemple, cette URL https://platform.uipath.com/odata/Robots(28) peut être écrite sous la forme https://platform.uipath.com/odata/Robots{id}, et la valeur du paramètre id peut être indiquée dans la fenêtre SegmentsURL. Ce champ ne prend en charge que les chaînes et les variables String.

Sortie

• En-têtes : Réponse reçue de requête HTTP.
• Pièce jointe de laréponse : la pièce jointe enregistrée à partir de la réponse.
• Contenu de la réponse : Réponse reçue de la requête HTTP en tant que variable de chaîne.
• Statut de la réponse : Code d'état reçu de la requête HTTP, en tant que variable entière.

Authentification simple

• Mot de passe (Password) - indique que le service Web utilise une authentification simple et vous permet de saisir votre mot de passe. L'ajout d'un nom d'utilisateur est également requis. Cette propriété prend en charge les chaînes et les variables de chaîne.
• MotdePasseSécurisé - indique que le service Web utilise une authentification sécurisée et vous permet de saisir votre mot de passe de chaîne sécurisée. L'ajout d'un nom d'utilisateur est également requis. Cette propriété prend en charge les variables au format chaîne.
• Nom d'utilisateur (Username) - indique que le service Web utilise une authentification simple et vous permet de saisir votre nom d'utilisateur. L'ajout d'un mot de passe est également requis. Cette propriété prend en charge les chaînes et les variables de chaîne.