Générer un flux API via l'outil de sérialisation

Document rédigé par Cyril Noel de L'Agence Savoie Mont Blanc

Afin de faciliter les échanges avec votre prestataire technique, vous pourriez être amenés à générer des fichiers JSON ou XML pour le guider sur le contenu à exploiter.

La solution ci-après est plus simple : Activer l’affichage des labels d’aide API - Exports, car elle permet d'accéder aux traductions de ce que votre prestataire reçoit dans le flux.

Toutefois, il est parfois nécessaire de récupérer le flux pour comparer avec votre prestataire et comprendre certains décalages.

Comment accéder à l'interface pour générer des flux JSON ou XML

Pour voir la ou les technologies utilisées par votre prestataire et le format de données, il faut se rendre dans votre projet, dans l'onglet "configuration technique".

Générer un flux, comprendre les options

1 - Pour vous (OT) le choix du projet n'a pas d'importance, en revanche pour votre agence, c'est essentiel, car il peut travailler avec plusieurs clients et c'est ce qui lui permet de récupérer les critères internes et descriptifs privés du bon client !

2 - Saisir l'identifiant de la fiche qui vous intéresse.

3 - "Locales" correspond à la sélection des langues. Bien regarder le texte d'aide qui précise comment les saisir. Si vous laissez vide, vous obtiendrez un flux en français uniquement. Si vous saisissez fr,en, alors vous aurez un flux dans les 2 langues.

4 - Vous avez intérêt à laisser @all. Cela vous permet de récupérer un flux complet.
À savoir, quand votre agence fait un appel à l'API avec son logiciel de programmation, elle ne récupère pas un flux complet par défaut et ne reçoit qu'une version française. Cela explique bien souvent les écarts que vous pouvez constater. Vous pouvez lui envoyer la documentation technique suivante : filtrage des langues qui traite de cela.

5 - Ce bouton va générer le flux. Vous allez visualiser dans la partie basse de l'écran ce que reçoit votre agence.

Le flux peut comporter plusieurs centaines de lignes, donc pour retrouver vos petits, il est fortement conseillé d'utiliser la fonction recherche de votre navigateur ou le raccourci clavier CTRL + F.