Contenu du cours

Comment récupérer des données depuis une API XML ?

Le traitement XML permet d'importer des données à partir d'une API pour les convertir au format CSV et les intégrer sur la plateforme Koumoul.

Dans ce tutoriel, nous verrons comment importer les données de la commande publique provenant 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 provenant de la salle des marchés de Mégalis Bretagne sont disponibles à partir de leur API. Nous testons ici leur API à l'aide de la documentation.

Sur la page de la documentation de l'API, plusieurs éléments sont disponbiles.
La partie qui nous intéresse est la section decp. Cliquez sur cette section et sur la ligne de la requête GET qui vous donne le chemin pour celle-ci.

Pour réaliser un requête, suivez ces étapes :

  1. Cliquez sur Try out,
  2. Renseignez le SIREN de Vannes Agglomération 200067932,
  3. Renseignez l'année 2024 pour avoir les données de cette année,
  4. Cliquez sur execute,
  5. Après quelques secondes, le résultat est disponbile sur le lien de téléchargement download file.

Vous pouvez ouvrir le fichier XML dans votre navigateur, le résultat devrait ressembler à celui-ci :


Si le fichier XML contient plusieurs lignes avec différentes balises, c'est que votre requête s'est bien déroulée.

En fonction de l'année ou du numéro SIREN que vous renseignez, il se peut que vous ayez un fichier vide.

Créez votre traitement d'import

Pour créer un traitement, vous devez disposer d'un plan avec des quotas de traitement et être administrateur de votre organisation.

Sur la page des traitements, ajoutez un traitement à l'aide du bouton d'action sur votre droite.

Choisissez le nom du traitement, sélectionnez le type XML et enregistrez-le.

Configurez votre traitement

Sur la page de configuration, vous pouvez :

  1. Rendre le traitement actif ou inactif ;
  2. Choisir la périodicité (mensuel, hebdomadaire ou horaire), ainsi que le jour et l'heure du traitement ;
  3. Choisir l'action du traitement : créer un jeu de données / mettre à jour un jeu de données de type fichier ou de type incrémental ;
  4. Renseigner l'adresse sur laquelle chercher le fichier dans les paramètres.

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.

Dans le premier paragraphe de ce cours, nous avons dit qu'il fallait renseigner 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 celle-ci :
https://data-api.megalis.bretagne.bzh/api/v1/decp/200067932/2024

Dans les balises du fichier, le séparateur est : /


Une fois que l'adresse est renseignée, cliquez sur le bouton d'action pour exécuter votre traitement une première fois, afin de vérifier qu'il n'y a pas d'erreur.

Un journal des exécutions est disponible en bas de 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 à notre image :

Si vous avez des remarques sur ce cours, n'hésitez pas à nous contacter pour nous en faire part.