API
Activités Studio Pro > Programmation > API. Comprend « Requête HTTP » et « Obtenir un token OAuth ».
Activités
| Requête HTTP | Obtenir un token OAuth |
|---|---|
| Envoie une requête HTTP avec les paramètres spécifiés | Effectue une autorisation OAuth 2.0 |
Requête HTTP
Description
Envoie une requête HTTP avec les paramètres spécifiés. Le bloc « Enregistrer la valeur dans une variable » apparaît automatiquement lorsque vous choisissez l’activité « Requête HTTP ». Il enregistre automatiquement la valeur dans une variable. Toutefois, ce bloc n’est pas obligatoire et peut être retiré du workflow.
Vous trouverez ci-dessous un exemple de configuration et d’utilisation de l’action pour obtenir la liste des astronautes actuellement en orbite.
Requête GET : combien de personnes se trouvent actuellement dans l’espace
Cette API renvoie le nombre actuel de personnes dans l’espace. Lorsqu’ils sont connus, elle renvoie également les noms de ces personnes et les vaisseaux spatiaux à bord desquels elles se trouvent. Cette API ne prend aucune entrée.
Le content-type utilisé par défaut dans l’activité Requête HTTP est application/json. Vérifiez toujours quel content-type est accepté par le point de terminaison que vous souhaitez utiliser. Si le point de terminaison exige un autre content-type, veillez à le spécifier dans les en-têtes supplémentaires.
Requête

Réponse
{
"people": [
{
"craft": [spacecraft name],
"name": [name]
},
...
],
"number": [numer of people],
"message": "success"
}
Paramètres
URL
Chemin de la ressource web à laquelle la requête sera envoyée, par exemple, http://en.wikipedia.org/w/api.php.
Méthode
Permet de choisir une méthode de requête : « GET », « POST », « PUT », « DELETE » ou « PATCH ».
En-tête d’autorisation
Permet d’ajouter des données d’autorisation si nécessaire.
Token Bearer
- Définir une valeur : permet de spécifier manuellement le token d’authentification.
- Calculer une valeur : permet d’utiliser une formule ou une méthode spécifique pour définir le token d’authentification.
- Enregistrer le résultat de l’étape précédente : utilise le résultat de l’activité précédente du workflow comme token d’authentification.
Plus d’en-têtes
Permet de définir des en-têtes de requête HTTP personnalisés, par exemple : {"Content-Type": "application/x-www-form-urlencoded"}.
Paramètres de requête
Permet de définir les paramètres de requête sous forme d’objet.
- Enregistrer le résultat de l’étape précédente : utilise le résultat de l’activité précédente comme objet contenant les paramètres.
- Calculer une valeur : permet d’utiliser les propriétés et méthodes disponibles pour former un objet, par exemple,
{action: "opensearch", search: "JavaScript", format: "xml"}.
Paramètres du corps
Disponible uniquement si la méthode « POST », « PUT », « DELETE » ou « PATCH » est sélectionnée. Contient les paramètres du corps sous forme d’objet.
- Enregistrer le résultat de l’étape précédente : utilise le résultat de l’activité précédente comme objet contenant les paramètres.
- Calculer une valeur : permet d’utiliser les propriétés et méthodes disponibles pour former un objet, par exemple :
{a:1,b:"row"}.
Envoyer un fichier
Disponible uniquement lorsque la méthode « POST » est sélectionnée. Ce paramètre permet d’envoyer un fichier dans la requête.
- Définir une valeur : permet de saisir directement le chemin du fichier à envoyer. Cliquez sur le bouton « Choisir » pour sélectionner le chemin manuellement.
- Enregistrer le résultat de l’étape précédente : utilise le résultat de l’activité précédente comme chemin.
- Calculer une valeur : permet d’utiliser les propriétés et méthodes disponibles pour former un chemin.
Fichier du champ de formulaire
Ce paramètre contient le nom du champ clé, dans le corps de la requête, qui contient le chemin du fichier à envoyer.
- Définir une valeur : permet de saisir directement le nom du champ, par exemple, file.
- Enregistrer le résultat de l’étape précédente : utilise le résultat de l’activité précédente comme nom.
- Calculer une valeur : permet d’utiliser les propriétés et méthodes disponibles pour former un nom.
Certificats
Ce paramètre permet de joindre un certificat client à la requête si le service l’exige. Pour ce faire, cochez la case « Joindre un certificat client » et sélectionnez un certificat dans la liste déroulante. Si vous n’avez ajouté aucun certificat, cliquez sur le bouton « Ajouter nouveau certificat ». Une fenêtre contextuelle s’ouvre alors avec un formulaire permettant d’ajouter un certificat. Une fois le formulaire rempli, cliquez sur « Ajouter » : la fenêtre se ferme. Le certificat ajouté est disponible dans l’onglet « Certificats » des paramètres de Studio Pro. Le même paramètre se trouve également dans Bot Runner.
Commentaire
Contient une annotation pour l’activité. Le texte saisi s’affiche au-dessus du nom de l’activité.
Résultat
Le résultat de la réponse est stocké par défaut dans la variable http_response. Le format de la variable dépend de l’adresse utilisée dans la requête. Par exemple, si vous utilisez l’API de Wikipedia et envoyez une requête avec la méthode « GET » et les paramètres {action: "opensearch", search: "JavaScript"}, le résultat suivant est renvoyé :
La réponse de l’API de Wikipedia :
[
"JavaScript",
[
"JavaScript",
"JavaScript syntax",
"JavaScript engine",
"JavaScript library",
"JavaScript InfoVis Toolkit",
"JavaScript Style Sheets",
"JavaScript templating",
"JavaScriptMVC",
"JavaScript framework",
"JavaScript OSA"
],
[
"JavaScript (), often abbreviated as JS, is a high-level, interpreted scripting language that conforms to the ECMAScript specification.",
"The syntax of JavaScript is the set of rules that define a correctly structured JavaScript program.",
"A JavaScript engine is a computer program that executes JavaScript (JS) code. The first JavaScript engines were mere interpreters, but all relevant modern engines utilize just-in-time compilation for improved performance.JavaScript engines are typically developed by web browser vendors, and every major browser has one.",
"A JavaScript library is a library of pre-written JavaScript which allows for easier development of JavaScript-based applications, especially for AJAX and other web-centric technologies.",
"The JavaScript InfoVis Toolkit provides tools for creating Interactive Data Visualizations for the Web.",
"JavaScript Style Sheets (JSSS) was a stylesheet language technology proposed by Netscape Communications Corporation in 1996 to provide facilities for defining the presentation of webpages.",
"JavaScript templating refers to the client side data binding method implemented with the JavaScript language.",
"JavaScriptMVC is an open-source rich Internet application framework based on jQuery and OpenAjax. It extends those libraries with a model–view–controller architecture and tools for testing and deployment.",
"A JavaScript framework is an application framework written in JavaScript. It differs from a JavaScript library in its control flow: A library offers functions to be called by its parent code, whereas a framework defines the entire application design.",
"JavaScript OSA, (originally JavaScript for OSA, abbreviated as JSOSA), is a freeware inter-process communication scripting language for the Macintosh computer."
],
[
"https://en.wikipedia.org/wiki/JavaScript",
"https://en.wikipedia.org/wiki/JavaScript_syntax",
"https://en.wikipedia.org/wiki/JavaScript_engine",
"https://en.wikipedia.org/wiki/JavaScript_library",
"https://en.wikipedia.org/wiki/JavaScript_InfoVis_Toolkit",
"https://en.wikipedia.org/wiki/JavaScript_Style_Sheets",
"https://en.wikipedia.org/wiki/JavaScript_templating",
"https://en.wikipedia.org/wiki/JavaScriptMVC",
"https://en.wikipedia.org/wiki/JavaScript_framework",
"https://en.wikipedia.org/wiki/JavaScript_OSA"
]
]
Exemples d’utilisation
Cette activité permet d’interagir avec différentes ressources web, son champ d’application est donc très large. Par exemple, dans un processus robotisé, vous pouvez l’utiliser pour vous connecter à une API web afin d’obtenir ou d’envoyer des données.
Obtenir un token OAuth
Description
Cette activité effectue une autorisation OAuth 2.0. Elle renvoie un token d’accès à utiliser dans d’autres activités.
Paramètres
URL d’autorisation
- Définir une valeur : permet de spécifier manuellement l’URL d’autorisation.
- Calculer une valeur : permet d’utiliser une formule ou une méthode spécifique pour déterminer l’URL d’autorisation.
- Enregistrer le résultat de l’étape précédente : utilise le résultat de l’action précédente du workflow comme URL d’autorisation.
Accéder à l’URL du token d’accès
- Définir une valeur : permet de spécifier manuellement l’URL du token d’accès.
- Calculer une valeur : permet d’utiliser une formule ou une méthode spécifique pour déterminer l’URL du token d’accès.
- Enregistrer le résultat de l’étape précédente : utilise le résultat de l’action précédente du workflow comme URL du token d’accès.
ID client
- Définir une valeur : permet de spécifier manuellement l’ID client.
- Calculer une valeur : permet d’utiliser une formule ou une méthode spécifique pour déterminer l’ID client.
- Enregistrer le résultat de l’étape précédente : utilise le résultat de l’action précédente du workflow comme ID client.
Secret client
- Définir une valeur : permet de spécifier manuellement le secret client.
- Calculer une valeur : permet d’utiliser une formule ou une méthode spécifique pour déterminer le secret client.
- Enregistrer le résultat de l’étape précédente : utilise le résultat de l’action précédente du workflow comme secret client.
Portée
- Définir une valeur : permet de spécifier manuellement la portée.
- Calculer une valeur : permet d’utiliser une formule ou une méthode spécifique pour déterminer la portée.
- Enregistrer le résultat de l’étape précédente : utilise le résultat de l’action précédente du workflow comme portée.
État
- Définir une valeur : permet de spécifier manuellement l’état.
- Calculer une valeur : permet d’utiliser une formule ou une méthode spécifique pour déterminer l’état.
- Enregistrer le résultat de l’étape précédente : utilise le résultat de l’action précédente du workflow comme état.
Utilisation
Par conception, le protocole OAuth 2.0 nécessite une intervention humaine. L’utilisateur doit saisir ses identifiants dans la fenêtre contextuelle et autoriser le robot à utiliser le service.
La plupart des services ont une durée de vie des tokens assez longue : plus de 14 jours. Il est donc judicieux de conserver le token et de ne solliciter l’utilisateur que lorsque c’est nécessaire.
La capture d’écran ci-dessous montre un exemple de workflow qui ne demande une autorisation à l’utilisateur que si l’ancien token n’est plus valide :
