Call API
Dernière mise à jour
Cet article vous a-t-il été utile ?
Dernière mise à jour
Cet article vous a-t-il été utile ?
L'action Call API permet d'envoyer une requête HTTP à une API et de récupérer les données retournées.
Pour utiliser cette action, vous devez :
1️⃣ Sélectionner une méthode de requête HTTP parmi (GET / POST / PATCH / PUT / DELETE)
2️⃣ Écrire l'URL de l'API à laquelle vous souhaitez envoyer la requête. Vous pouvez utiliser des variables dans cet URL.
3️⃣ Paramétrer les Headers de votre requête, notamment pour transmettre des informations supplémentaires au serveur ou pour authentifier votre requête.
4️⃣ Paramétrer les Query String, pour ajouter des données à la requête. Souvent utile pour transmettre des données dans des requêtes de type GET.
5️⃣ Paramétrer les Fields, pour ajouter des données à la requête. Les Fields représentent le body d'une requête HTTP et sont disponibles pour les requêtes GET, POST, PATCH et PUT. Le Body est transmis au format JSON. Pour paramétrer les Fields, vous devez choisir le type de données utilisées parmi String, Number et JSON. 👉🏼 Choisir le type de donnée des Fields.
6️⃣ Tester la requête, vous pouvez alors utiliser le schéma fourni par votre test. Le schéma nous permet de déterminer le type de données renvoyé par le Call API ainsi que les variables qui pourront être utilisées par la suite. Par exemple si vous voulez afficher le résultat de votre requête dans un texte avec variable. Le schéma reste modifiable après le test. Voici la liste des types de données du Call API :
Les types de retour classique : Text, Number et Booléen.
Fichier : retourne un fichier dont le nom et l'extension ont été paramètré soit par le test de requête soit manuellement. Il est possible de variabiliser le nom du fichier.
[ ] Array : retourne une liste d'éléments. Le type des éléments peut être : Text, Number, Booléen, Fichier, Array ou Collection.
{ } Collection : retourne une collection d'élément avec une clé et un type. Le type des éléments peut être : Text, Number, Booléen, Fichier, Array ou Collection.
Lors du test de la requête, il faut remplacer les variables Ksaar par des valeurs de test afin que le call API renvoie le bon format de données. Ce format pourra ensuite être réutilisé dans Ksaar.
Il est possible de choisir la façon dont vous renseignez les données dans le corps d'une requête :
par Clé / Valeurs
par JSON brut
Dans ce mode d'édition, Ksaar construit le JSON transmis dans la requête. Ainsi, il suffit de rentrer les clés et leurs valeurs correspondantes (du type adéquat) et la requête sera correctement formatée par Ksaar lors du call API.
Les Fields permettent d'ajouter des données à la requête HTTP. Ils représentent le body d'une requête et sont disponibles pour les requêtes GET, POST, PATCH et PUT. Pour paramétrer les Fields, vous devez choisir le type de données utilisées parmi String, Number et JSON.
Pour les données de type String, vous pouvez inclure la valeur sous forme de chaîne de caractères. Par exemple, si vous avez un champ "Nom" de type string, vous pouvez inclure la valeur du nom en tant que chaîne de caractères dans les Fields de la requête.
Pour les données de type Number, vous pouvez inclure la valeur en tant que nombre. Assurez-vous que la valeur que vous fournissez est numérique. Si la valeur fournie n'est pas un nombre, elle sera interprétée comme nulle (null) dans la requête.
Pour les données de type JSON, vous pouvez associer des objets JSON dans les valeurs à des clés classiques. Assurez-vous néanmoins de respecter un syntaxe JSON valide. Cela inclut l'utilisation de guillemets autour des noms de clés et des valeurs, ainsi que la séparation des paires clé-valeur par des virgules.
Vous pouvez inclure des variables en remplaçant les valeurs attendues par les variables correspondantes, en les plaçant entre des guillemets. Cela vous permet de dynamiquement utiliser des valeurs provenant de Ksaar dans vos requêtes.
L'option JSON clé / valeurs est différente de l'éditeur JSON pur :
Le field clés / valeurs JSON permet de renseigner du JSON dans la valeur associée à une clé.
L'éditeur JSON sert à renseigner le JSON incluant directement les clés et les valeurs en un.
Le type de donnée JSON permet de transmettre des formats de données plus complexes comme des array par exemple. Il permet donc d'avoir le contrôle total sur ce qui est envoyé, tout en ayant la possibilité d'intégrer des variables Ksaar.
Le contenu renseigné dans l'éditeur JSON sera transmis tel quel dans la requête API. Ainsi, vous devez vous assurer de l'exactitude du format de la donnée.
Comme mentionné précédemment, il faut utiliser ce mode de saisie lorsque vous souhaitez construire vous-même le corps de la requête. Le cas d'usage typique est l'utilisation de composants plus complexes qu'il est impossible de faire avec le field clé / valeurs.
