L'étape API du Flow Builder permet d'effectuer des appels d'API définis au format JSON (le XML n'est pas pris en charge).
Composition d'un appel d'API
Dans le Flow Builder, un appel d'API se compose des éléments suivants :
Élément | Description |
|---|---|
HTTP Method | Indique le type d'action à effectuer sur la ressource. Méthodes prises en charge : GET, POST, PUT, DELETE, PATCH. |
URL | L'adresse de l'endpoint de l'API appelée. |
Headers | Informations complémentaires envoyées avec la requête, comme l'authentification ou le type de contenu. Les en-têtes sont des paires clé-valeur, dont les valeurs sont toujours traitées comme des chaînes de caractères. |
Body | Les données envoyées avec la requête, au format JSON. |
Enregistrer les données de la réponse
Vous pouvez enregistrer tout ou partie de la réponse de l'API (au format JSON) dans des variables, à l'aide d'une requête JMESPath qui extrait et transforme les données de la réponse JSON.
Présentation de JMESPath :
JMESPath est un langage de requête qui permet de parcourir des données JSON et d'en extraire des informations. Pour en savoir plus, consultez les spécifications officielles et le tutoriel.
Configurer une requête JMESPath :
Utilisez l'onglet JMESPath du Parsing Helper.
Collez un exemple de réponse de l'API dans le champ « JMESpath value ».
JSON**Example Response** { "data": { "places": [ { "label": "Paris (tous aéroports)", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "PAR", "parent": null, "type": "area" }, { "label": "Paris Orly", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "ORY", "parent": "PAR", "type": "airport" }, { "label": "Paris Roissy/Charles de Gaulle", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "CDG", "parent": "PAR", "type": "airport" }, { "label": "Paris - Beauvais", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "BVA", "parent": "PAR", "type": "airport" }, { "label": "Paris Vatry", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "XCR", "parent": "PAR", "type": "airport" } ] } }Saisissez la requête JMESPath dans le champ « Template ».
Exemple de requête :
data.places[0]
Cliquez sur « Submit » pour vérifier que la valeur « Render » correspond bien à ce que vous voulez enregistrer dans une variable.
JSON**Example Render { "label": "Paris (tous aéroports)", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "PAR", "parent": null, "type": "area" }**
☁️ L'étape API du Flow Builder ne prend pas en charge les filtres JMESPath personnalisés tels que approx, remove_accents, belongs_to, replace, replace_all, unique et remove_duplicates.