Quand vous utilisez le créateur d’intégration, vous pouvez transférer les paramètres de demande (chaînes, chiffres, booléens, tableaux, etc.) au corps de la demande API. Cette fonctionnalité vous offre une plus grande souplesse pour les intégrations API et prend en charge un plus grand nombre de cas d’utilisation. Dans cet article, nous allons vous guider et vous expliquer le processus de configuration de ces paramètres.
Cet article aborde les sujets suivants :
- Configuration du type de paramètre dans les paramètres de demande
- Ajout du reformatage aux paramètres de type tableau
- Utilisation des paramètres dans le corps de la demande de l’appel API
- Test de votre configuration
Articles connexes :
Configuration du type de paramètre dans les paramètres de demande
Pour configurer le type de paramètre dans les paramètres de demande
- Allez à la section Paramètres de la demande dans le créateur d’intégration.
- Définissez votre paramètre et configurez son type sur l’un des types suivants :
- Chaîne : pour les données textuelles comprises entre guillemets (par exemple, "exemple de texte").
- Chiffre : pour les valeurs numériques (par exemple, 123).
- Booléen : pour les valeurs true/false.
-
Tableau : pour une collection de valeurs (par exemple, ["élément1", "élément2"]).
Ajout du reformatage aux paramètres de type tableau
À des fins de test dans le créateur d’intégration avec les paramètres de type tableau, vous devez ajouter une fonction de reformatage pour garantir le traitement approprié de ce type de données. Pour ce faire, utilisez la fonction suivante :
$eval($)
La fonction analyse la valeur de la chaîne dans un objet de type tableau.
Si le paramètre est déjà un objet de type tableau, la fonction ne modifie pas son comportement.
Pour en savoir plus, consultez Reformatage des valeurs dans les paramètres de demande pour agents IA.
Utilisation des paramètres dans le corps de la demande de l’appel API
Dans le corps de la demande de l’appel API, ces paramètres peuvent être utilisés dans le même format que les paramètres de chaîne, en utilisant la syntaxe : {{<REQUEST_PARAMETER>}}
Alors qu’il est possible que le paramètre apparaisse visuellement comme une chaîne dans le corps (comme vous pouvez le voir sur la capture d’écran ci-dessous), pendant l’exécution, il sera converti au type de données correspondant, spécifié dans la section Paramètres de la demande.
Test de votre configuration
Utilisez le bouton Tester en production dans le créateur d’intégration pour exécuter votre appel API.
Vérifiez que les paramètres sont transférés avec le type correct (chaîne, chiffre, booléen, tableau) dans la demande.
Vérifiez la réponse pour vous assurer que l’API les traite correctement.