Comment récupérer des données depuis une API XML ?
Le traitement Import XML permet d'importer des données depuis une API, de les convertir au format CSV, et de les intégrer sur la plateforme Data Fair.
Dans ce tutoriel, nous allons voir comment importer les données de la commande publique de la salle des marchés de Mégalis Bretagne pour Vannes Agglomération.
Découvrir l'API XML de Mégalis
Les données de la commande publique de la salle des marchés de Mégalis Bretagne sont accessibles via leur API. Nous allons tester cette API en suivant la documentation fournie.
Sur la page de la documentation de l'API, plusieurs éléments sont disponibles. La section qui nous intéresse est la partie decp. Cliquez sur cette section, puis sur la ligne de la requête GET pour obtenir le chemin correspondant.
Pour effectuer une requête, suivez ces étapes :
- Cliquez sur Try out,
- Renseignez le SIREN de Vannes Agglomération : 200067932,
- Indiquez l'année 2024 pour obtenir les données de cette année,
- Cliquez sur Execute,
- Après quelques secondes, le résultat sera disponible via le lien de téléchargement Download file.
Vous pouvez ouvrir le fichier XML dans votre navigateur ; le résultat devrait être similaire à l'image ci-dessous :
Si le fichier XML contient plusieurs lignes avec différentes balises, cela indique que votre requête s'est bien déroulée.
Selon l'année ou le numéro SIREN que vous renseignez, il est possible que vous obteniez un fichier vide, indiquant qu'aucune commande n'a été passée pour cette année.
Créez votre traitement d'import
Pour créer un traitement, il est nécessaire de disposer d'un plan incluant des quotas de traitement et d'être administrateur de votre organisation.
Sur la page des traitements, utilisez le bouton d'action pour ajouter un traitement.
Sélectionnez un nom pour le traitement, choisissez le type Import XML, puis enregistrez.
Configurez votre traitement
Sur la page de configuration, vous avez la possibilité de :
- Activer ou désactiver le traitement ;
- Sélectionner l'action du traitement : créer un jeu de données ou mettre à jour un jeu de données de type fichier ou incrémental ;
- Définir la périodicité (mensuelle, hebdomadaire ou horaire), ainsi que le jour et l'heure d'exécution du traitement ;
- Spécifiez l'adresse source de l'API.
Comme vous pouvez le constater sur l'image, nous avons choisi de déclencher le traitement manuellement pour importer les marchés concernant Vannes Agglomération pour 2024.
Dans la section des paramètres, vous pouvez renseigner l'adresse de l'API.
Comme indiqué dans le premier paragraphe de ce cours, il est nécessaire d'inclure le code SIREN et l'année dans une requête GET :
https://data-api.megalis.bretagne.bzh/api/v1/decp/{siren}/{annee}
L'adresse à renseigner dans les paramètres est donc la suivante :
https://data-api.megalis.bretagne.bzh/api/v1/decp/200067932/2024
Dans les balises du fichier, le séparateur utilisé est : /
Une fois tous les paramètres renseignés, cliquez sur le bouton d'action pour Exécuter votre traitement une première fois et vérifier l'absence d'erreurs.
Le journal des exécutions est disponible en bas de la page de configuration.
À la fin de l'exécution, le jeu de données est automatiquement créé et les données dans le tableau devraient ressembler à l'image suivante :
Si vous avez des remarques sur ce cours, n'hésitez pas à nous les communiquer.