Appeler le service web REST
L'activité Appeler le service web REST récupère des données de différentes sources sur Internet. Dans l'étape, les requêtes adressées à l'URI de la source renvoient une réponse avec une charge utile formatée en HTML, XML, JSON ou autre. La réponse est soit présentée sous forme HTML en tant que page actuelle, soit stockée dans une variable.
Si le service web renvoie une erreur, le message n'est pas renvoyé par l'activité. Au lieu de cela, l'activité générera une erreur qui peut être traitée à l'aide des mécanismes de gestion d'erreur standard.
L'authentification prise en charge pour cette étape d'activité comprend Negotiate, NTML, Digest, Basic et OAuth. Vous pouvez configurer la méthode d'authentification pour cette étape dans l'onglet Tous les chargements en cliquant sur Plus sous Options dans les propriétés de l'étape. Pour plus d'informations sur les protocoles, voir Authentification web. Lors de la définition des paramètres du protocole Negotiate pour le robot entier ou pour cette étape uniquement, le fichier spn.txt n'est pas utilisé.
Propriétés
L'activité Appeler le service web REST peut être configurée à l'aide des propriétés suivantes :
- URL
-
L'URL de base du service web, à l'exclusion des paramètres. L'URL peut être spécifiée de plusieurs manières à l'aide du Sélecteur d'URL.
- Requête
-
Ici, vous spécifiez le type de requête à effectuer. REST prend en charge cinq opérations de base :
- GET
-
Utilisée pour interroger des données. Pour les requêtes GET, vous pouvez spécifier un certain nombre de paramètres et/ou de fichiers sous forme de paires nom/valeur à transmettre avec la requête. Cliquez sur '+' pour ajouter un nouveau paramètre ou télécharger un fichier.
- POST
-
Utilisée pour mettre à jour certaines parties de données. Pour les requêtes POST, vous pouvez soit spécifier un certain nombre de paramètres sous forme de paires nom/valeur, soit donner le corps entier de la requête. Si vous spécifiez la requête avec des paramètres, vous devez choisir d'utiliser POST (application/x-www-form-urlencoded) ou MULTIPART (multipart/form-data) pour coder les paramètres. Si vous indiquez le corps entier ('brut') de la requête, vous devez spécifier le type de contenu des données de la requête.
Pour les requêtes POST et PUT, le codage MULTIPART peut être sélectionné pour activer le téléchargement de fichiers. Si une variable binaire est sélectionnée comme valeur d'un paramètre Chargement de fichier, les octets sont envoyés tels quels. Si le codage Base64 est souhaité, la valeur du paramètre doit être une expression base64Encode(data) où data est le nom de la variable contenant la valeur binaire. Dans ce cas, il est également recommandé de spécifier la valeur base64 comme Codage du transfert de contenu – sinon, ce champ peut normalement être laissé vide.
- PUT
-
Utilisée pour remplacer des données. Voir POST pour une description des différentes manières de spécifier une requête PUT.
- SUPPRIMER
-
Utilisée pour supprimer des données. Pour les requêtes DELETE, vous pouvez spécifier un certain nombre de paramètres et/ou de fichiers sous forme de paires nom/valeur à transmettre avec la requête. Cliquez sur '+' pour ajouter un nouveau paramètre ou télécharger un fichier.
- PATCH
- Utilisée pour modifier des données. Pour les requêtes PATH, vous pouvez spécifier un certain nombre de paramètres et/ou de fichiers sous forme de paires nom/valeur à transmettre avec la requête. Cliquez sur '+' pour ajouter un nouveau paramètre ou télécharger un fichier.
- Accepter
-
Les types de contenu qui seront acceptés comme réponse. Par défaut, tout type de réponse sera accepté. Les types de contenu acceptés peuvent être spécifiés de plusieurs manières à l'aide du Sélecteur de valeur.
- Codage
-
Le codage qui sera utilisé pour coder les caractères spéciaux dans la requête. Le codage utilisé pour décoder la réponse est contrôlé à l'aide de l'option Étape, dans l'onglet Chargement de la page.
- Données de sortie
-
Ici, vous sélectionnez ce qu'il advient de la sortie de l'appel du service web.
- Charger dans le navigateur
-
Le résultat est chargé dans la fenêtre actuelle, comme s'il avait été le résultat d'une activité Charger une page. Vous pouvez configurer le comportement du navigateur à l'aide de la propriété Options décrite ci-dessous.
- Stocker dans une variable
-
Le résultat est stocké dans la variable sélectionnée.
- Auth. préemptive
- Activez cette option pour envoyer préalablement l'en-tête d'autorisation afin d'accélérer le processus d'autorisation. Lorsque l'authentification préemptive est activée, Design Studio envoie la réponse d'authentification Basique ou Digest avant que le serveur ne renvoie une erreur 401 Réponse non autorisée. Pour utiliser l'authentification préemptive, vous devez configurer les identifiants par défaut dans les Options ci-dessous.
Lors de l'utilisation de l'authentification Digest, chaque algorithme contient deux variantes : session et non-session. Un algorithme de session se définit comme <nom>, par exemple SHA-256, et l'algorithme de non-session se définit comme <nom>-sess, par exemple SHA-256-sess.
- Options
-
Vous pouvez remplacer les options du robot par les propres options de l'étape. Une option marquée d'un astérisque dans la boîte de dialogue Options remplacera celle de la configuration du robot. Toutes les autres options seront les mêmes que celles spécifiées pour le robot.