Loading....
Print Friendly, PDF & Email

DESCRIPTION

Les API du Service Dume permettent 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 acheteurs et opérateurs économiques de réaliser toutes les étapes de saisie, complétion et consultation des DUME. Chaque fonctionnalité est portée par une opération relevant d'une des API suivantes :

  • API DUME A (pour les DUME Acheteurs)
  • API DUME OE (pour les DUME Opérateurs Economiques)
  • API Métadonnées (pour intervenir uniquement sur les métadonnées d'un DUME)
  • API Données (pour récupérer des données issues de sources tierces comme API Entreprises)
  • API Référentiel (pour interroger les référentiels du service DUME)
  • API E-Certis (pour récupérer les attestations via API Entreprises

Cette page présente les opérations due Service DUME, classées par API.

Veuillez noter qu'il appartient à chaque éditeur de concevoir pour son profil d'acheteur l'ergonomie et les cinématiques d'utilisation du DUME, les opérations du Service DUME permettant simplement l'échange des données constitutives du DUME, sans préjuger de l'interface homme machine mise en œuvre par les différentes places de marché.

Fonctionnement des services exposés du Service DUME

Les services exposés sont organisés par domaine et par type d’opération.

L’utilisation d’URI globaux permet de distinguer à quel domaine s’adressent les opérations demandées. Pour rappel, une URI de l'anglais Uniform Resource Identifier, soit "identifiant uniforme de ressource", est une courte chaîne de caractères identifiant une ressource sur un réseau (par exemple une ressource Web) physique ou abstraite, et dont la syntaxe respecte une norme d'Internet mise en place pour le World Wide Web.

Liste des URI des référentiels du Service DUME

Domaine
URI correspondante
Données
https://chorus-pro.gouv.fr:5443/service/dume/donnees
DUME acheteur
https://chorus-pro.gouv.fr:5443/service/dume/dumeA
DUME Opérateur Economiquehttps://chorus-pro.gouv.fr:5443/service/dume/dumeOE
Métadonnées
https://chorus-pro.gouv.fr:5443/service/dume/metadonnees
Référentiels
https://chorus-pro.gouv.fr:5443/service/dume/referentiels

 

Un paramètre d’entrée intitulé opération permet de déterminer la fonctionnalité qu’on souhaite activer (ex: rechercherDume, enregistrerDume, fusionnerDume, recupererModelDume,...). On note qu’une même opération peut être appliquée à un ou plusieurs domaine(s).

Ainsi, pour les cas d'utilisation similaires entre dume A et dume OE, on utilisera le même nom d'opération. La différentiation s’effectuera au niveau de l'URI sous laquelle l’opération est réalisée. Par exemple, si on effectue « opération=enregistrerDume » avec utilisation de l'URI "../dumes/dumeA", on réalisera l’enregistrement d'un DUME A.

 

Le tableau ci-dessous illustre quelques-uns des cas d’opérations réalisables sur une ou plusieurs URI :

OpérationDomaine(s) applicable(s)
rechercherDume

DUME A ; DUME OE
enregistrerDume
DUME A ; DUME OE
fusionnerDume
DUME OE
recupererModelDumeDUME A ; DUME OE
etc.etc.

Le paramètre d'entrée "opération" est toujours complété par d'autres paramètres (par exemple, l'identifiant du profil d'acheteur concerné) permettant d'exécuter la requête. Dans le cas où plusieurs paramètres identiques sont indiqués, alors seul le dernier est considéré par la solution.

Pour rappel, les API permettent l’utilisation du référentiel Service DUME. Leur implémentation demande également à l’éditeur un travail de conception afin de proposer des fonctionnalités plus simples et plus adaptées à l’utilisateur.

Formalisme des appels :

Les appels de service sont structurés autour d’un flux JSON encapsulant le fichier XML qui contient le DUME proprement dit. Veuillez noter à ce propos que les seuls DUME dématérialisés reconnus par la réglementation sont des DUME de format XML, respectant un formalisme défini par l’Union Européenne. Tout autre format donné à un DUME (ex : PDF) ne vaut que copie, et ne saurait constituer un original à valeur probante.

 

Le flux JSON contient le nom de l’opération à exécuter, des paramètres d’entrée permettant d’exécuter l’appel ainsi que des données complémentaires au DUME appelées « métadonnées ». Celles-ci permettent soit d’assurer la bonne gestion technique du DUME soit d’apporter des informations complémentaires non présentes dans le fichier XML. Afin de connaître le contenu exact des métadonnées, il est nécessaire de consulter la liste des API.

 

Les réponses apportées aux appels passés à destination du service DUME obéissent aux mêmes règles. Cependant, les JSON émis par le service DUME retournent en guise de données des « paramètres de sortie ». Les paramètres d’entrée et de sortie propres à chaque appel vous seront présentés dans le descriptif de chaque API, plus loins dans le présent document.

 

Le formalisme du JSON est standardisé :

  • une requête est encadrée par des crochets : {}
  • chaque paramètre ou opération est défini par un titre entre guillemets : “ ”
  • chaque donnée est encadrée par des guillemets : “ ”
  • chaque ensemble titre et données est séparé du suivant par une virgule : ,
  • le dernier champ de l’appel ne doit pas être suivi d’une virgule, cette dernière étant interprétée comme prélude au renseignement d’un nouveau champ,
  • le XML est saisi encodé en base 64 dans le JSON.

Les requêtes mal formulées donnent lieu à des messages d’erreur précisant la nature du problème identifié.

Vous trouverez ci-dessous les codes erreurs les plus fréquents :

CODE ERREURDescriptionSortie API
PARAM_MISSING

Paramètre présent dans la requête, mais pas attendu par l'API {
"type": "ERREUR",
"code": "PARAM_MISSING",
"message": "Le champs 'xxx' n'existe pas et ne doit pas être renseigné"
},
PARAM_REQUIRED
Paramètre non présent dans la requête, mais attendu par l'API{
"type": "ERREUR",
"code": "PARAM_REQUIRED",
"message": "Le champs 'xxx' est manquant"
},
PARAM_MAXLENGTH
La valeur du paramètre attendu a une longueur supérieure à la valeur attendue{
"type": "ERREUR",
"code": "PARAM_MAXLENGTH",
"message": "Le champs 'xxx' est mal formaté : longueur maximale 18"
},
PARAM_FORMAT
La valeur du format du paramètre en entrée n'est pas conforme au format attendu {
"type": "ERREUR",
"code": "PARAM_FORMAT",
"message": "Le champs 'xxx' est mal formaté"
},
PARAM_MINLENGTH
La valeur du paramètre attendu a une longueur inférieure à la valeur attendue{
"type": "ERREUR",
"code": "PARAM_MINLENGTH",
"message": "Le champs 'xxx' est mal formaté : longueur minimale 1"
}
InternalErrorErreur système{
"type": "ERREUR",
"code": "InternalError",
"message": "Erreur Interne serveur"
}

La requête ci-dessous permet l’enregistrement d’un DUME acheteur au statut validé dans le référentiel Service DUME. Si le DUME A n’a jamais été enregistré dans le référentiel auparavant, il est inutile de renseigner un numéro d’ID dans le JSON d’entrée.

Une fois l’appel API effectué, le Service DUME stocke le XML du DUME enregistré dans la base Service DUME et retourne un numéro d’identification unique à l’acheteur.

Liste des opérations par API

Les API présentées ci-dessous sont disponibles depuis le 3 avril 2018. Elles sont ouvertes aux éditeurs raccordés au Service DUME. Pour plus d'information au sujet du raccordement en production ou en qualification, merci de consulter la page suivante : https://communaute.chorus-pro.gouv.fr/documentation/acces-aux-api-du-service-dume/.

Pour rappel, les opérations effectuées sur les DUME A (DUME Acheteur) s’effectuent à l’URI suivante : https://chorus-pro.gouv.fr:5443/service/dume/dumeA

  • recupererModelDume : permet de récupérer un modèle de DUME A vierge.
  • recupererDumeFormate : permet de récupérer un DUME A dans un format donné (ex : PDF, HTML, ...).
  • enregistrerDume : permet d'enregistrer un DUME A dans le Service DUME et, le cas échéant, d'obtenir son identifiant.
  • rechercherDumes : permet de lancer une recherche de DUMEs dans Service DUME.
  • creerDumeSimple : permet de solliciter la création d’un DUME « simple », correspondant aux critères des procédures réalisées dans le cadre des marchés publics simplifiés.
  • supprimer DUME : permet de supprimer un DUME

L’URI pour l’API DUME OE (DUME Opérateur Economique) est la suivante : https://chorus-pro.gouv.fr:5443/service/dume/dumeOE

  • recupererModelDume : permet de récupérer un DUME OE vierge.
  • recupererDumeFormate : permet de récupérer un DUME OE dans un format donné (ex : PDF, HTML, ...).
  • enregistrerDume : permet d'enregistrer un DUME OE dans le Service DUME et  le cas échéant d'obtenir son identifiant.
  • fusionnerDumeAvecDonneesEntreprise : permet de fusionner un DUME OE avec un DUME A et/ou avec les données publiques ou privées de l'entreprise.
  • creerdumeOEavecSiretOE : permet de récupérer un xml DUME OE à partir d'un identifiant, complété par les informations publiques ou privées de l'opérateur économique.
  • fusionnerDume : permet de récupérer la fusion d'un DUME OE et d'un DUME A dont elle a les numéros ou les XML, complétée des données BOAMP.
  • ajouterPJ : permet d'ajouter une pièce jointe à un DUME.
  • rechercherDUME : permet de récupérer les ID des DUMES répondant à un certain nombre de critères (ID_consultation, SIRET OE, …).
  • Analyser une réponse : permet d'analyser un DUME.
  • Supprimer un DUME : Permet de supprimer une DUME.
  • telechargerDUMEAvecPJ : Permet de télécharger un ou plusieurs DUME OE et de récupérer au besoin, depuis les API entreprise, les éventuelles pièces jointes ajoutées par l'OE.

L’URI pour l’API Métadonnées DUME est la suivante : https://chorus-pro.gouv.fr:5443/service/dume/métadonnées

  • mettreAJourDume : permet de mettre à jour les métadonnées associées à un DUME Acheteur ou Opérateur Economique.

L’URI pour l’API attestations est la suivante : https://chorus-pro.gouv.fr:5443/service/dume/donnees

L’URI pour l'API référentiel est la suivante : https://chorus-pro.gouv.fr:5443/service/dume/Referentiel

  • Lister référentiel :  Le profil d'acheteur souhaite connaître la liste des référentiels présents dans le Service DUME.
  • Lister valeurs de référentiel : Le profil d'acheteur souhaite connaître la liste des valeurs d'un des référentiels présent dans le Service DUME.
  • Récupérer libellés :  Le profil d'acheteur souhaite récupérer les libellés du formulaire DUME.

L’URI pour l'API référentiel est la suivante : https://chorus-pro.gouv.fr:5443/service/dume/ecertis

  • recupererEvidence :  Permet de récupérer les déclinaisons nationales et les évidences associées aux critères européens d’exclusion et de sélection

Dernière mise à jour : avril 12, 2019  

3360    DUME  
Total 6 Votes:
4

Dites-nous comment pourrions-nous améliorer cette publication ?

+ = Êtes-vous un robot ?

Back To Top