Présentation de l'API Données Essentielles


Ce document s’adresse aux éditeurs de profils d’acheteurs. Il présente l’API Données Essentielles. L'API Données Essentielles du Service DUME permet aux éditeurs d’intégrer toutes les fonctionnalités du Service DUME aux profils d’acheteurs qu’ils administrent.

Les fonctionnalités proposées permettent aux éditeurs de réaliser toutes les étapes d'enregistrement, de mise à jour, de récupération des identifiants et des ensembles de données essentielles.

 

Table des matières

 

 

1       Opération d’enregistrement des données essentielles

 

1.1        Présentation de l’opération

 

Lorsqu’un profil d’acheteur souhaite enregistrer des données essentielles dans la base de données DUME, il doit avoir recours à l’opération enregistrerDE de l’API Données essentielles.

 

Cette API permet d’enregistrer les données essentielles issues des paramètres passés en entrée.

 

Illustration du processus d'enregistrement des données essentielles

 

L’identifiant unique de marché est unique à chaque acheteur. Il fait partie des données essentielles à publier. Néanmoins, il peut y avoir des doublons dans le cas où plusieurs profils d’acheteur ont les mêmes règles de nommage. Le numéro de marché est donc systématiquement associé à un acheteur.

 L’identifiant de référence fonctionnelle est la référence Donnée Essentielle - Service DUME unique donnée lors de l’enregistrement des données essentielles afin de garantir l’unicité.

 

Ces identifiants permettent par la suite de modifier ou de récupérer les données essentielles enregistrées dans le Service DUME. Il est important de noter que les données de base du marché ne sont pas modifiables après publication.

 

Cas particuliers :

 

1.2        Spécifications

 

1.2.1       Environnements 

 

URL de Production : https://api.aife.economie.gouv.fr/dume/donneesEssentielles

 

URL de Qualification : https://sandbox-api.aife.economie.gouv.fr/dume/donneesEsssentielles

 

1.2.2       Paramètres du Header

 

Certificat (O) : format Varchar

Content-type (O) : format Varchar

Exemple : curl -v -X POST --insecure --cert xxxxx.pem https://api.aife.economie.gouv.fr/dume/donneesEssentielles -d "{}"

Les accolades encadrent le JSON.

 

1.2.3       Paramètres d’entrée 

 

 

1.2.4       Exemple de JSON IN (marchés publics)

 

{

"operation": "enregistrerDE",

"rsDemandeur": "EntrepriseX",

"idDemandeur": "38103128500491",

"plateforme":

{

"typeIdPlateforme": "1",

"idPlateforme": "33592022900036",

"idTechniquePlateforme": "azerty"

},

"idConsultation": "11223344556677",

"refFonctionnelleConsultation": "referenceconsultationX",

"lot" : "1",

"typeDE":"MP",

"accessible": "True",

"id": "2018123456789100",

"acheteur":

{

"id": "13001977100018",

"nom": "AcheteurX"

},

"nature": "Marche",

"objet": "Marche public X",

"codeCPV": "12345678",

"procedure": "Appel d'offres ouvert",

"lieuExecution":

{

"code": "93160",

"typeCode": "Code Postal",

"nom": "CommuneX"

},

"dureeMois": "8",

"dateNotification": "2018-07-12",

"datePublicationDonnees": "2018-07-12",

"montant": "123456.78",

"formePrix": "Ferme",

"titulaires":

[

{

"typeIdentifiant": "SIRET",

"id": "79858993300000",

"denominationSociale": "Entreprise1"

},

{

"typeIdentifiant": "TAHITI",

"id": "587850000",

"denominationSociale": "Entreprise2"

}

],

 

"modifications":

[

{

"objetModification": "Modification délai, montant, titulaire",

"datePublicationDonneesModification": "2018-07-15",

"dureeMois": "10",

"montant": "987654.32",

"titulaires":

[

{

"typeIdentifiant": "TVA",

"id": "FR21483209000",

"denominationSociale": "Entreprise3"

},

{

"typeIdentifiant": "RIDET",

"id": "1234567000",

"denominationSociale": "Entreprise4"

}

],

"dateSignatureModification": "2018-07-15"

}

] }

 

1.2.5       Exemple de JSON IN  (contrats de concession)

 

{

"operation": "enregistrerDE",

"rsDemandeur": "EntrepriseX",

"idDemandeur": "38103128500491",

"plateforme":

{

"typeIdPlateforme": "1",

"idPlateforme": "33592022900036",

"idTechniquePlateforme": "azerty"

},

"idConsultation": "11223344556677",

"refFonctionnelleConsultation": "Reference consultation X",

"lot" : "1",

"typeDE":"CC",

"accessible": "True",

"id": "2018123456789100",

"autoriteConcedante":

{

"id": "13001977100018",

"nom": "AcheteurX"

},

"nature": "Concession de travaux",

"objet": "ConcessionX",

"procedure": "Procedure negociee ouverte",

"lieuExecution":

{

"code": "93160",

"typeCode": "Code Postal",

"nom": "CommuneX"

},

"dureeMois": "8",

"dateSignature": "2018-07-12",

"datePublicationDonnees": "2018-08-06",

"dateDebutExecution": "2018-09-30",

"valeurGlobale": "7789456.56",

"montantSubventionPublique": "12456.32",

"donneesExecution":

[

{

"datePublicationDonneesExecution": "2019-02-17",

"depensesInvestissement": "12345.5",

"tarifs":

[

{

"intituleTarif": "TarifX",

"tarif": "115.5"

},

{

"intituleTarif": "TarifXX",

"tarif": "12000.2"

}

] }

],

"concessionnaires":

[

{

"typeIdentifiant": "SIRET",

"id": "79858993300000",

"denominationSociale": "Entreprise1"

}

],

"modifications":

{

"objetModification": "Modification durée, valeurGlobale",

"datePublicationDonneesModification": "2018-11-09",

"dureeMois": "24",

"valeurGlobale": "123321123.12",

"dateSignatureModification": "2018-12-24"

}

}

 

1.2.6       Paramètre de JSON OUT

 

 

2    Opération de mise à jour des données essentielles

 

2.1       Présentation de l’opération

 

Lorsqu’un profil d’acheteur souhaite modifier les données essentielles contenues dans la base de données Service DUME, elle doit avoir recours à l’opération MettreAJourDonneesEssentielles de l’API Données essentielles.

 

La mise à jour concerne des données communiquées au Service DUME mais non publiées, non encore communiquées ou encore les données de modification et d’exécution.

 

Un message est envoyé au profil d’acheteur pour l’informer de la modification ou non de la donnée.

 

Illustration du processus de mise à jour des données essentielles

 

Lorsque les données ont été publiées, les données de base du marché ne peuvent pas être mises à jour.

 

L’opération MettreAJourDonneesEssentielles de l’API Données essentielles permet également de compléter les données essentielles transmises au Service DUME. En effet, si les données envoyées lors de l’enregistrement étaient incomplètes, elles peuvent être complétées grâce à l’opération de mise à jour.

 

Plus concrètement, dans le cas où un acheteur aurait modifié une donnée de base dans sa consultation alors que les données ont déjà été envoyées au Service DUME, il sera possible de l’amender si elle n’est pas publiée.

 

Les données d’exécution et de modification sont historisées et non remplacées. Ainsi, la donnée d’exécution ou de modification la plus récente sera positionnée en premier dans le format JSON.

 

Ex : Cas où il est nécessaire de remplacer le titulaire initial par un autre titulaire, changement du montant, etc.

 

2.2       Spécifications

 

2.2.1      Environnements

 

URL de Production : https://api.aife.economie.gouv.fr/dume/donneesEssentielles

 

URL de Qualification : https://sandbox-api.aife.economie.gouv.fr/dume/donneesEsssentielles

 

2.2.2      Paramètres du Header

 

Certificat (O) : format Varchar

Content-type (O) : format Varchar

Exemple : curl -v -X POST --insecure --cert xxxxx.pem https://api.aife.economie.gouv.fr/dume/donneesEssentielles -d "{}"

Les accolades encadrent le JSON.

 

2.2.3      Paramètres d’entrée

 

 

2.2.4      Paramètres de sortie

 

 

2.2.5      Exemple de JSON IN (marché public)

 

{

"operation": "mettreAJourDonneesEssentielles",

"rsDemandeur": "EntrepriseX",

"idDemandeur": "38103128500491",

"plateforme":

{

"typeIdPlateforme": "1",

"idPlateforme": "33592022900036",

"idTechniquePlateforme": "azerty"

},

"refFonctionnelleDE": "A REMPLIR APRES LA CREATION DE",

"accessible": "True",

"id":"2018123456789100",

"modifications":

{

"objetModification": "Modification délai, montant, titulaire",

"datePublicationDonneesModification": "2018-07-17",

"dureeMois": "14",

"montant": "654987123.32",

"titulaires":

[

{

"typeIdentifiant": "FRWF",

"id": "FRWFARPECAL",

"denominationSociale": "Entreprise1"

},

{

"typeIdentifiant": "HORS-UE",

"id": "BRDASILVAMOTORES",

"denominationSociale": "Entreprise2"

}

],

"dateSignatureModification": "2018-07-17"

}

}

 

2.2.6      Exemple de JSON IN (contrat de concession) :

 

{

"operation": "mettreAJourDonneesEssentielles",

"rsDemandeur": "EntrepriseX",

"idDemandeur": "38103128500491",

"plateforme":

{

"typeIdPlateforme": "1",

"idPlateforme": "33592022900036",

"idTechniquePlateforme": "azerty"

},

"refFonctionnelleDE": "A REMPLIR APRES LA CREATION DE",

"accessible": "True",

 

"id":"2018123456789100",

"donneesExecution":

[

{

"datePublicationDonneesExecution": "2019-02-17",

"depensesInvestissement": "12344545.5",

"tarifs":

[

{

"intituleTarif": "TarifXX",

"tarif": "1115.5"

},

{

"intituleTarif": "TarifXXX",

"tarif": "12006540.2"

}

] }

],

"modifications":

{

"objetModification": "Modification durée, valeurGlobale V2",

"datePublicationDonneesModification": "2018-08-08",

"dureeMois": "54",

"valeurGlobale": "451123.12",

"dateSignatureModification": "2018-08-09"

}

}

 

3    Opération de récupération de l’identifiant d’un ensemble de données essentielles

 

3.1       Présentation de l’opération

 

Lorsqu’un profil d’acheteur souhaite récupérer le ou les identifiant(s) des données essentielles associé(s) à un lot et une consultation, elle doit avoir recours à l’opération recupererIdDE de l’API Données essentielles.

 

La place de marché est informée si la donnée a été modifiée ou non par un message.

Illustration du processus de récupération d'identifiant de données essentielles

 

 

3.2       Spécifications

 

3.2.1      Environnements

 

URL de Production : https://api.aife.economie.gouv.fr/dume/donneesEssentielles

 

URL de Qualification : https://sandbox-api.aife.economie.gouv.fr/dume/donneesEsssentielles

 

3.2.2      Paramètres du Header

 

Certificat (O) : format Varchar

Content-type (O) : format Varchar

Exemple : curl -v -X POST --insecure --cert xxxxx.pem https://api.aife.economie.gouv.fr/dume/donneesEssentielles -d "{}"

Les accolades encadrent le JSON.

 

3.2.3      Paramètres d’entrée 

 

 

3.2.4      Paramètres de sortie

 

 

3.2.5      Exemple de JSON IN (marchés publics)

 

{

"operation": "recupererIdDE",

"rsDemandeur": "EntrepriseX",

"idDemandeur": "38103128500491",

"plateforme":

{

"typeIdPlateforme": "1",

"idPlateforme": "33592022900036",

"idTechniquePlateforme": "azerty"

},

"idConsultation": "11223344556677",

"refFonctionnelleConsultation": "reference consultation X",

"lot" : "1",

"dateDebutPublication": "2018-07-12",

"dateFinPublication": "2018-12-12",

"id":"2018123456789100",

"acheteur":

{

"id": "13001977100018"

}

}

 

3.2.6      Exemple de JSON IN (contrats de concession)

 

{

"operation": "recupererIdDE",

"rsDemandeur": "EntrepriseX",

"idDemandeur": "38103128500491",

"plateforme":

{

"typeIdPlateforme": "1",

"idPlateforme": "33592022900036",

"idTechniquePlateforme": "azerty"

},

"idConsultation": "11223344556677",

"refFonctionnelleConsultation": "reference consultation X",

"lot" : "1",

"dateDebutPublication": "2017-07-13",

"dateFinPublication": "2020-07-13",

"id": "2018123456789100",

"autoriteConcedante":

{

"id": "13001977100018"

}

}

 

4    Opération de récupération des données essentielles

 

4.1       Présentation de l’opération

 

Lorsqu’un profil d’acheteur souhaite récupérer les données essentielles contenues dans la base de données DUME, il doit avoir recours à l’opération recupererDE de l’API Données essentielles.

 

Cette opération permet au profil d’acheteur de publier les données essentielles sans avoir à les stocker dans sa base de données. Dans le cas où les données essentielles sont contenues dans la base de données Service DUME, elles sont retournées au format PDF, XML ou HTML, en complément du format JSON.

 

Cette API récupère l’ensemble des données essentielles issues des critères de recherche passés en paramètre d’entrée.

 

Illustration du processus de récupération de données essentielles

 

 

4.2       Spécifications

 

4.2.1       Environnements

 

URL de Production : https://api.aife.economie.gouv.fr/dume/donneesEssentielles

 

URL de Qualification : https://sandbox-api.aife.economie.gouv.fr/dume/donneesEsssentielles

 

4.2.2      Paramètres du Header

 

Certificat (O) : format Varchar

Content-type (O) : format Varchar

Exemple : curl -v -X POST --insecure --cert xxxxx.pem https://api.aife.economie.gouv.fr/dume/donneesEssentielles -d "{}"

Les accolades encadrent le JSON.

 

4.2.3      Paramètres d’entrée 

 

 « 3 » (Structure hors UE) – Code pays + 16 premiers caractères raison sociale

 

4.2.4      Exemple de JSON IN (Marché public)

 

{

"operation": "recupererDE",

"rsDemandeur": "EntrepriseX",

"idDemandeur": "38103128500491",

"plateforme":

{

"typeIdPlateforme": "1",

"idPlateforme": "33592022900036",

"idTechniquePlateforme": "azerty"

},

"idConsultation": "11223344556677",

"refFonctionnelleConsultation": "reference consultation X",

"lot" : "1",

"dateDebutPublication": "2018-07-12",

"dateFinPublication": "2018-12-12",

"refFonctionnelleDE": "A REMPLIR APRES LA CREATION DE",

"typeDE":"MP",

"format" : "1",

"id": "2018123456789100",

"acheteur":

{

"id": "13001977100018",

"nom": "Acheteur"

},

"nature": "Marche",

"codeCPV": "12345678",

"procedure": "Appel d'offres ouvert",

 

"titulaires":

[

{

"typeIdentifiant": "TVA",

"id": "FR21483209000",

"denominationSociale": "Entreprise1"

},

{

"typeIdentifiant": "RIDET",

"id": "1234567000",

"denominationSociale": "Entreprise2"

}

] }

 

4.2.5      Exemple de JSON IN (contrat de concession)

 

{

"operation": "recupererDE",

"rsDemandeur": "Entreprise X",

"idDemandeur": "38103128500491",

"plateforme":

{

"typeIdPlateforme": "1",

"idPlateforme": "33592022900036",

"idTechniquePlateforme": "azerty"

},

"idConsultation": "11223344556677",

"refFonctionnelleConsultation": "reference consultation X",

"lot" : "1",

"dateDebutPublication": "2017-07-13",

"dateFinPublication": "2020-07-13",

"refFonctionnelleDE": "A REMPLIR APRES LA CREATION DE",

"typeDE":"CC",

"format" : "1",

"id": "2018123456789100",

"autoriteConcedante":

{

"id": "13001977100018",

"nom": "AcheteurX"

},

"nature": "Concession de travaux",

"procedure": "Procedure negociee ouverte",

"concessionnaires":

[

{

"typeIdentifiant": "SIRET",

"id": "79858993300018",

"denominationSociale": "Entreprise1"

}

] }