Cas pratique : appel API avec Plans

[mathieuf]

Réalisons le séquéncement suivant :

1. Préparation de données
2. Appel API pour enrichir ces données
3. Analyse de la réponse

Pour réaliser ces étapes nous utiliserons Designer Cloud et Plans.

Voici une vue d'ensemble de notre ordonnancement avec Plans :

Première étape : préparation des données

Mon fichier de départ sera un fichier CSV avec des magasins et des adresses postales.

Ma première étape consiste a nettoyer mes adresses postales en supprimant les caractères spéciaux (é, à, è, -, ' ....). J'aurai pu utiliser un fichier mais j'ai choisi de faire appel à un Text Input combiné avec l'outil Find Replace.

Une fois cette étape réaliser je peux créer les 4 champs nécessaire à mon appel API (URL, Method, Headers, Body).

URL:

Replace('https://data.geopf.fr/geocodage/search?q=' + [Adresse postale], ' ', '%20')

Ajout de l'URL pour l'appel API suivi de l'adresse postale et codage des espaces avec le code web correspondant '%20'

Method

'GET'

Headers et Body peuvent être vide mais les champs doivent exister.

''

Avec l'outil Select je supprime le champ Adresse Postale dont je n'ai plus besoin.

Puis je sauvegarde le fichier de sortie en CSV dans mon Alteryx Data Storage.

Seconde étape : l'appel API avec Plans

Ouvrez l'application Plans et ajoutez une première étape Alteryx Cloud. Selectionnez le workflow créé précedemment et vérifiez la configuration de l'étape comme suit :

Ensuite en cas de succès ajoutez une étape HTTP et cochez la case Load Configuration from Dataset.

Choissisez un nom de fichier pour stocker le résultat retourné par l'API (Attention, nous reviendrons sur cette configuration un peu plus loin).

Nous pouvons maintenant construire le second workflow pour analyser les résultats de l'API.

Troisième étape : Analyse du retour API

Pour ce workflow nous utiliserons 2 entrées de données : le retour de l'API et le fichier produit par l'étape 1 pour retrouver toutes les caractéristiques de nos données (catégories, KPI, ...), le jointure se faisant sur l'URL.

Nous pouvons faire un parsing du fichier produit par l'API avec l'outil JSON Parse.

Ne souhaitant conserver que les coordonnées X et Y de ce retour, j'effectue quelques étapes de transformations.

Puis je stocke le fichier final (obligatoire pour que le process global fonctionne).

Finalisation avec Plans

Retour dans Plans pour ajuster l'épape HTTP en ajoutant temp au nom du fichier pour ne pas générer un fichier horodaté à chaque execution du Plan et cocher la case Delete Dataset After Plan Execution.

Nous pouvons ajouter le workflow de parsing du fichier JSON créé en cas de succès de l'appel API et vérifier la configuration. And voilà ! 😉

Bonnes pratiques

Vous pouvez ajouter des emails personnalisés (avec variables) en cas d'échec et de succès des étapes de votre choix.

Si celà est pertinent vous avez aussi la possibilité d'ajouter des étapes de Logic comme des délais ou un système d'approbation.

Worflows et Plan.zip