Documentation développeur

Préambule

Disclaimer vocabulaire

Le vocable utilisé a migré en cours de route depuis appel d'offres vers consultation. L'api se sert toujours du terme d'appel d'offres. La mise en conformité avec le vocabulaire métier se fera ultérieurement et la rétrocompatibilité sera gardée.

Fonctionnalités en cours de développement

Certaines fonctionnalités de cette documentation sont en cours de développement, celles-ci seront affichés en orange .

Création de consultations

Identification

Afin de pouvoir interagir avec la plateforme en tant que place de marché, il faut vous fournir un identifiant auprès du SGMAP .

Cet identifiant est un entier, associé à votre place de marché en interne sur notre plateforme. Cet identifiant est passé à chaque appel sur l'API, avec comme clé place_id .

Dans un premier temps (en phase de tests), la valeur de cette clé n'est pas vérifiée, mais doit tout de même être remplie (par exemple avec la valeur 1), en paramètre GET, de la manière suivante sur chaque URL : ?place_id=1 .

Types d'embed

Il y a deux types d'embed possibles :

  • Par redirection à l'aide d'un bouton qui est un lien pointant vers une URL spécifique. La procédure se base donc entièrement sur la plateforme du MPS.
  • Par iframe à l'aide d'une balise d'iframe, ce qui permet de rester sur le site actuel

Il faudra sélectionner le bon namespace de l'URL à utiliser : /redirection ou /iframe.
Chaque exemple ci-dessous se verra accompagné des deux URLs possibles.

L'embed iframe n'est pas supporté pour les versions d'Internet Explorer 6 à 9.
Cela est du à un blocage des cookies tiers par défaut dans une iframe pour ces versions d'IE. Cela bloque donc l'identification d'un acheteur dans une fenêtre car il y a utilisation de cookies.

Solutions possibles :
  • Demander aux utilisateurs de mettre à jour leur navigateur (peu recommandé sauf si très petit pool d'utilisateurs bienveillants)
  • Utiliser un IF IE pour les liens et ainsi rerouter les utilisateurs concernés dans un embed redirection au lieu d'un embed iframe (solution par défaut)
  • Utiliser uniquement des embed redirection

Les différentes plateformes

Dans la suite de ce document vous verrez parfois apparaître : <DOMAINE> Il faut remplacer cette balise soit par l'adresse de la plateforme de production ( mps.apientreprise.fr ) ou la plateforme de pre-production ( mps-dev.apientreprise.fr ).

Espace places de marché

Afin de pouvoir vous connecter sur l'espace pour les places de marché, il faut fournir une adresse email valide auprès du SGMAP. Les inscriptions sont effectuées manuellement, un mot de passe est généré automatiquement et envoyé sur cette adresse email.

Il est conseillé de changer ce mot de passe à la première connexion.


Pour vous connecter sur cet espace, il faut vous rendre à l'adresse suivante : https://mps.apientreprise.fr/places/sign_in


Création et visionnage des consultations

Préambule

La section ci-dessous explique comment créer des appels d'offres sur le site MPS, de manière automatique ou manuelle

Pré-requis

Afin de créer une consultation, il faut renseigner les informations suivantes :

  • le titre de la consultation ;
  • l'url du lien vers la consultation ;
  • un email de contact acheteur : cet email sert à envoyer un code PIN à 4 chiffres qui permet d'accéder
  • aux différentes candidatures pour cette consultation.
  • un identifiant pour la consultation : choisir une clé primaire interne, référence unique à la place.

Les différents champs sont chacun limités à 255 caractères
L'identifiant pour la consultation servira par la suite pour interagir avec les différents embeds décrit ci-dessous.

Restrictions sur la clé primaire

La clé primaire doit être composé exclusivement :

  • de caractères alphanumériques (a-z, A-Z et 0-9) ;
  • des caractères "-" (tiret) ou "_" (underscore) ;
  • de 255 caractères au plus.

Quelques exemples :
place-marche_acheteur-567
placeMarcheAcheteurDupontJean
placeMarche_acheteur-567

Création manuelle

Un formulaire est disponible à l'adresse suivante pour créer une consultation : https://mps.apientreprise.fr/places/appels_offres/new . Afin de pouvoir ajouter une consultation, il faut vous fournir un identifiant auprès du SGMAP.

Création automatique à l'aide d'un moissonneur

Afin d'automatiser le processus, vous pouvez exposer un flux RSS sur votre place de marché qui sera moissonné de manière périodique par le système. L'intervalle de moissonnage est actuellement de 30 minutes. Vous devez au préalable indiquer l'URL correspondant au flux RSS dans l'interface disponible depuis /places/

Le format du flux RSS est le suivant:

<rss version="2.0">
<channel>
<title>MPS</title>
<link>http://www.placedemarche.fr/rss/mps</link>
<description>Flux RSS des marchés MPS</description>
<item>
<title>Titre du marché</title>
<link>http://www.placedemarche.fr/urluniquedumarche_contenant_sa_reference_interne_unique</link>
<description>(facultatif)</description>
<category domain="buyerEmail">acheteur@servicepublic.fr</category>
<category domain="appelOffreId">réference interne unique</category>
</item>
<item>
...
</item>
</channel>
</rss>

Les différentes balises au sein de la balise item sont les suivantes :

  • title Le titre de la consultation (et non sa référence) ;
  • link Le lien de la consultation ;
  • description La description de la consultation ;
  • category[domain="buyerEmail"] L'adresse email de l'acheteur de la consultation ;
  • category[domain="appelOffreId"] La clé primaire de la consultation.

Il est primordial d'avoir la bonne syntaxe de flux RSS pour que les appels d'offres soient ajoutés et que les candidatures à ces consultations puissent se passer correctement. Un message d'erreur vous avertir si jamais le système ne comprend pas la syntaxe ou si l'adresse du flux RSS fournie est invalide.

Déclenchement manuel du moissonneur

Lorsque vous venez de créer une consultation il se peut que vous souhaitiez déclencher un moissonnage pour pouvoir tester le reste de la chaîne. Un bouton est à votre disposition dans votre interface. Il n'apparait que si vous avez déjà renseigné une URL de moissonage valide.

Création automatique à l'aide de l'API

Afin de créer une consultation via l'API, il faut un jeton d'authentification, disponible dans la partie place de marché : il faut vous founir un identifiant auprès du SGMAP pour vous connecter sur cet espace privé ( disponible sur /places ).

L'url de création est la suivante : /api/v1/places/appels_offres

Il faut effectuer une méthode POST avec les paramètres suivants :

  • auth_token Le jeton d'authentification : obligatoire
  • appel_offre[slug] l'identifiant de la consultation
  • appel_offre[title] le titre de la consultation
  • appel_offre[url] l'url de la consultation
  • appel_offre[email_contact_acheteur] l'adresse email de l'acheteur

Les différents champs sont chacun limités à 255 caractères

Si la requête a été effectuée avec succès, le serveur renvoi 200 avec le modèle au format json.

Si la requête a échouée, le serveur renvoi 422 et les erreurs du modèle au format json.


Validation du dépot de la candidature

Préambule

La section ci-dessous permet d'indiquer si le candidat a bien été jusqu'au bout de la démarche sur la place de marché. Cette API doit être appelée lorsque le dépot du candidat est fini sur la place de marché. Cet api permet également de créer les candidatures pour les places qui n'utilisent pas les embeds MPS mais qui passent directement par APIENTREPRISE.

Pré-requis

Afin de pouvoir confirmer le dépot, il faut :

  • un jeton d'authentification, disponible dans la partie place de marché
  • l'identifiant de la consultation

L'url à utiliser est la suiante : /api/v1/places/appels_offres/:appel_offre_id/candidatures/:identifiant/confirm

Il est possible d'identifier la candiature à confirmer de deux moyens : par l'identifiant ou par le siret

En utilisant l'identifiant de la candidature :

Il faut effectuer une méthode PUT avec les paramètres suivants :

  • auth_token Le jeton d'authentification
  • appel_offre_id l'identifiant de la consultation utilisé pour la création de celle-ci à remplacer directement dans l'url
  • identifiant l'identifiant MPS de la candidature à remplacer directement dans l'url
  • type_identifiant avec la valeur "id"


En utilisant le siret de l'établissement

Il faut effectuer une méthode PUT avec les paramètres suivants :

  • auth_token Le jeton d'authentification
  • appel_offre_id l'identifiant de la consultation utilisé pour la création de celle-ci à remplacer directement dans l'url
  • identifiant le siret de l'entreprise à remplacer directement dans l'url
  • type_identifiant avec la valeur "siret"
  • siret_mandataire Si la candidature fait parti d'un groupement, il faut au préalable avoir créé la candidature du mandataire puis faire l'appel pour le cotraitant en précisant le siret de l'établissement mandataire
  • create Dans le cas où vous n'utilisez pas les embeds (Cas de l'AIFE avec PLACE), il faut rajouter le paramètre create avec la valeur true pour que cela crée la candidature pour pouvoir avoir des statistiques correctes.

Exemple

Confirmer une candidature existante avec son identifiant

Identifiant de la consutlation : MPS_consultation_test

curl -H "Content-Type: application/json" -X PUT "https://mps.apientreprise.fr/api/v1/places/appels_offres/MPS_consultation_test/candidatures/2433/confirm"  -d '{"auth_token": "mon_token", "type_identifiant": "id"}'

Confirmer une candidature existante avec son siret

Siret de l'entreprise : 41816609600051
Identifiant de la consutlation : MPS_consultation_test

curl -H "Content-Type: application/json" -X PUT "https://mps.apientreprise.fr/api/v1/places/appels_offres/MPS_consultation_test/candidatures/41816609600051/confirm"  -d '{"auth_token": "mon_token", "type_identifiant": "siret"}'

Confirmer une candidature existante faisant parti d'un groupement avec son siret

Siret de l'entreprise : 41816609600051
Siret du mandataire : 41123069100049
Identifiant de la consutlation : MPS_consultation_test

curl -H "Content-Type: application/json" -X PUT "https://mps.apientreprise.fr/api/v1/places/appels_offres/MPS_consultation_test/candidatures/41816609600051/confirm"  -d '{"auth_token": "mon_token", "type_identifiant": "siret", "siret_mandataire": "41123069100049"}'

Création et confirmation d'une candidature

Siret de l'établissement : 41816609600051
Identifiant de la consultation : MPS_consultation_test

curl -H "Content-Type: application/json" -X PUT "https://mps.apientreprise.fr/api/v1/places/appels_offres/MPS_consultation_test/candidatures/41816609600051/confirm"  -d '{"auth_token": "mon_token", "type_identifiant": "siret", "create": true}'

Création d'un candidature faisant partie d'un groupement

Pour créer une candidature qui fait partie d'un groupement, il faut que la candidature du mandataire soit créée précédement (voir exemple précédent).
Siret de l'établissement mandataire : 41816609600051
Siret de l'établissement cotraitant : 41123069100049
Identifiant de la consultation : MPS_consultation_test

curl -H "Content-Type: application/json" -X PUT "https://mps.apientreprise.fr/api/v1/places/appels_offres/MPS_consultation_test/candidatures/41123069100049/confirm"  -d '{"auth_token": "mon_token", "type_identifiant": "siret", "create": true, "siret_mandataire": "41816609600051"}'

Retours

  • 200 : { "message":"Candidature confirmed" }
  • 201 : { "message":"Candidature created and confirmed" }
  • 400 : { "error":"Missing params" }
  • 400 : { "error":"invalid type_identifiant : should be id or siret" }
  • 401 : { "error": "invalid auth_token" }
  • 404 : { "error": "Candidature not found" }
  • 404 : { "error": "Mandataire not found" }

Déclaration de l'entreprise retenue pour une consultation

Préambule

La section ci-dessous permet d'indiquer quelle entreprise a été retenue pour la consultation.

Pré-requis

Afin de pouvoir déclarer l'entreprise retenue pour une consultation, il faut :

  • que la consultation soit enregistrée sur notre plateforme ;
  • que vous possédiez l'identifiant de cette consultation ;
  • un jeton d'authentification, disponible dans la partie place de marché ;
  • que vous connaissiez le siret de l'entreprise ou l'identifiant MPS de la candidature.

L'url à utiliser est la suivante : /api/v1/places/appels_offres/:appel_offre_id/winner

Il faut effectuer une méthode PUT avec les paramètres suivants :

  • auth_token Le jeton d'authentification
  • appel_offre_id l'identifiant de la consultation utilisé pour la création de celle-ci à remplacer directement dans l'url
  • le siret de l'entreprise gagnante ou l' id de la candidature gagnante

Si la requête a été effectuée avec succès, le serveur renvoi 200.

Si la requête a échouée, elle renvoie 400 ou 404 avec un message d'erreur au format json.

Exemple

Pour déclarer quelle entreprise a été retenue à partir de son siret (41816609600051) pour la consultation ayant pour identifiant MPS_consultation_test, voici la requête :

curl -H "Content-Type: application/json" -X PUT "https://mps.apientreprise.fr/api/v1/places/appels_offres/MPS_consultation_test/winner"  -d '{"auth_token": "mon_token", "siret": "41816609600051"}'

Pour déclarer à partir de l'identifiant de la candidature, voici la requête :

curl -H "Content-Type: application/json" -X PUT "https://mps.apientreprise.fr/api/v1/places/appels_offres/MPS_consultation_test/winner"  -d '{"auth_token": "mon_token", "id": "4321"}'

Retours

  • 200 : { "message": "consultation updated" }
  • 400 : { "error": "invalid appel_offre_id" }
  • 400 : { "error": "missing param id or siret" }
  • 401 : { "error": "invalid auth_token" }
  • 404 : { "error": "candidature not found" }

Intégration de l'embed pour candidater à une consultation

Préambule

La section ci-dessous permet d'obtenir sur une page présentant un appel d'offre, validé par le MPS, la procédure pour candidater à la consultation sur la plateforme MPS

Pré-requis

Afin de pouvoir candidater à une consultation, il faut :

  • que la consultation soit enregistrée sur notre plateforme ;
  • que vous possédiez l'identifiant de cette consultation ;
  • que vous possédiez un identifiant pour votre place de marché.

Implémentation

Le format du lien est le suivant : /vendeur/candidatures/new avec les paramètres suivants en GET :

  • place_id L'identifiant de votre place de marché ;
  • appel_offre_id L'identifiant de la consultation utilisé lors de la création de celle-ci ;
  • callback_url L'adresse internet de callback afin de récupérer les informations de la candidature ;
  • siret Un numéro de siret, ce paramètre est optionnel.
  • user_id Un identifiant pour votre utilisateur connecté. Cet identifiant sert à des fins de tracabilité des actions sur la plateforme MPS.
    Si l'utilisateur n'est pas connecté sur votre plateforme, laissez la clé vide.

On obtient donc pour l'iframe : http://<DOMAINE>/iframe/vendeur/candidatures/new et pour la redirection : http://<DOMAINE>/redirection/vendeur/candidatures/new

Comportement lorsque le paramètre siret est inclus

La candidature est construite directement avec le numéro de siret, et la page affiche toutes les informations de l'établissement.

Comportement lorsque le paramètre siret est omis

La candidature est construite sans le numéro de siret, la page affiche donc un formulaire pour entrer un numéro de siret. Lorsqu'un numéro de siret valide est entré, l'utilisateur se retrouve dirigé sur une page affichant toutes les informations de l'établissement, la même que celle décrite ci-dessus.

Gestion du callback_url en fin de candidature

A la fin de la candidature sur la plateforme MPS, le système redirige l'utilisateur sur l'adresse url définie dans la variable callback_url avec en paramètre l'id de la candidature, dans la clé candidature_id .

Accès aux informations de la candidature persistée

Afin d'accéder à toutes les informations de la candidature, il faut que vous utilisiez l'id fournit dans la clé candidature_id fournie à la fin du processus de candidature (et décrit dans la section ci-dessus).

La récupération de la candidature s'effectue sur l'url suivant : http://<DOMAINE>/api/v1/candidatures/:id avec :id l'identifiant de la candidature.

Afin de télécharger directement le PDF public de la candidature, il faut passer par l'api à l'adresse suivante https://<DOMAINE>/api/v1/candidatures/7.pdf?place_id=1 avec 7 l'id de la candidature. Ne pas oublier de rajouter l'extension pdf à la fin de l'url, sinon l'API retourne la candidature au format json.

Les candidatures accessibles de cette manière sont seulement celles qui ont été entièrement terminées par le vendeur.

Si la candidature n'existe pas ou n'a pas été terminée, le système renvoi un status 404 avec le message d'erreur suivant : Il n'y a pas de dossier administratif MPS pour cette entreprise.

Vous trouverez un exemple à l'adresse suivante : https://test.apientreprise.fr/embed_vendeur/start.html


Intégration de l'embed pour les acheteurs : visionnage de toutes les candidatures

Préambule

La section ci-dessous permet de visionner les différentes candidatures d'une consultation, candidatures effectuées sur la plateforme MPS.

Pré-requis

Afin de pouvoir visionner toutes les candidatures, il faut :

  • que la consultation soit enregistrée sur notre plateforme ;
  • que vous possédiez l'identifiant de cette consultation ;
  • que vous possédiez un identifiant pour votre place de marché.

Protection par code PIN

La consultation sur la plateforme est enregistrée avec une adresse email de contact, adresse nécessaire afin de récupérer par email un code PIN permettant de visionner les candidatures à la consultation.

Ce code PIN, généré à la création de la consultation, est un numéro constitué de 4 chiffres. Lorsque celui-ci est entré, la session est valable pendant 24h, au delà il faut se re-identifier.

Il est possible de récupérer ce code PIN de manière automatique via l'API, et de le passer dans les paramètres pour consulter les candidatures. Plus de détails dans la section Récupération du code PIN d'une consultation via l'API .

Implémentation

Le format du lien est le suivant : /acheteur/appels_offres/:appel_offre_id avec les paramètre suivants :

  • appel_offre_id L'identifiant de la consultation utilisé pour la création de celle-ci. Ce paramètre est à placer dans l'url à la place de :appel_offre_id . Cet identifiant est celui fourni pour la création de la consultation ;
  • place_id L'identifiant de votre place de marché, à placer en variable GET.
  • pin Le code PIN de la consultation. Ce paramètre est optionnel et permet d'effectuer une authentification automatique.

On obtient donc pour l'iframe : http://<DOMAINE>/iframe/acheteur/appels_offres/:id et pour la redirection : http://<DOMAINE>/redirection/acheteur/appels_offres/:id

Vous trouverez un exemple à l'adresse suivante : https://test.apientreprise.fr/embed_acheteur/all.html


Intégration de l'embed pour les acheteurs : visionnage d'une candidature à l'aide d'un id de candidature

Préambule

La section ci-dessous permet de visionner une candidature spécifique à une consultation, à l'aide du numéro de l'id de la candidature

Pré-requis

Afin de pouvoir visionner une candidature, il faut :

  • que la consultation soit enregistrée sur notre plateforme ;
  • que vous possédiez un identifiant pour votre place de marché ;
  • que vous possédiez l'id de la candidature.

Protection par code PIN

La consultation sur la plateforme est enregistrée avec une adresse email de contact, adresse nécessaire afin de récupérer par email un code PIN permettant de visionner les candidatures à la consultation.

Ce code PIN, généré à la création de la consultation, est un numéro constitué de 4 chiffres. Lorsque celui-ci est entré, la session est valable pendant 24h, au delà il faut se re-identifier.

Il est possible de récupérer ce code PIN de manière automatique via l'API, et de le passer dans les paramètres pour consulter les candidatures. Plus de détails dans la section Récupération du code PIN d'une consultation via l'API .

Implémentation

Le format du lien est le suivant : /acheteur/candidatures/:id avec les paramètre suivants :

  • id L'id de la candidature. Ce paramètre est à placer dans l'url à la place de :id .
  • place_id L'identifiant de votre place de marché
  • pin Le code PIN de la consultation. Ce paramètre est optionnel et permet d'effectuer une authentification automatique.

On obtient donc pour l'iframe : /iframe/acheteur/candidatures/:id et pour la redirection : /redirection/acheteur/candidatures/:id

Pour accéder directement au PDF (lien télécharger les Informations Administratives de l'entreprise), utiliser l'URL ci-dessus, en ajoutant l'extension pdf à l'url.
Un bouton est prévu sur l'interface pour le télécharger.

Vous trouverez un exemple à l'adresse suivante : https://test.apientreprise.fr/embed_acheteur/one_id.html


Intégration de l'embed pour les acheteurs : visionnage d'une candidature à l'aide d'un siret

Préambule

La section ci-dessous permet de visionner une candidature spécifique à une consultation, à l'aide du numéro de siret de l'entreprise candidate liée à la candidature.

Cette méthode permet seulement de récupérer la dernière candidature effectuée par l'etablissement, contrairement à la méthode avec l'id de la candidature.

Pré-requis

Afin de pouvoir visionner une candidature, il faut :

  • que la consultation soit enregistrée sur notre plateforme ;
  • que vous possédiez l'identifiant de cette consultation ;
  • que vous possédiez un identifiant pour votre place de marché ;
  • que vous possédiez le numéro de siret de l'etablissement ayant émis la candidature.

Protection par code PIN

La consultation sur la plateforme est enregistrée avec une adresse email de contact, adresse nécessaire afin de récupérer par email un code PIN permettant de visionner les candidatures à la consultation.

Ce code PIN, généré à la création de la consultation, est un numéro constitué de 4 chiffres. Lorsque celui-ci est entré, la session est valable pendant 24h, au delà il faut se re-identifier.

Il est possible de récupérer ce code PIN de manière automatique via l'API, et de le passer dans les paramètres pour consulter les candidatures. Plus de détails dans la section Récupération du code PIN d'une consultation via l'API .

Implémentation

Le format du lien est le suivant : /acheteur/appels_offres/:appel_offre_id/candidatures/:siret avec les paramètre suivants :

  • appel_offre_id L'identifiant de la consultation fourni pour la création de celle-ci. Ce paramètre est à placer dans l'url à la place de :appel_offre_id .
  • siret Le numéro de siret de l'établissement ayant émis la candidature liée à la consultation. :siret .
  • place_id L'identifiant de votre place de marché
  • pin Le code PIN de la consultation. Ce paramètre est optionnel et permet d'effectuer une authentification automatique.

On obtient donc pour l'iframe : /iframe/acheteur/appels_offres/:appel_offre_id/candidatures/:siret et pour la redirection : /redirection/acheteur/appels_offres/:appel_offre_id/candidatures/:siret

Pour accéder directement au PDF (lien télécharger les Informations Administratives de l'entreprise), utiliser l'URL ci-dessus, en ajoutant l'extension pdf à l'url.
Un bouton est prévu sur l'interface pour le télécharger.

Vous trouverez un exemple à l'adresse suivante : https://test.apientreprise.fr/embed_acheteur/one_siret.html


Intégration de l'embed pour les acheteurs : visionnage des pièces jointes d'une candidature à l'aide de l'id de la candidature

Préambule

La section ci-dessous permet de visionner les pièces jointes d'une candidature spécifique à une consultation, à l'aide du numéro de l'id de la candidature

Pré-requis

Afin de pouvoir visionner les pièces jointes d'une candidature, il faut :

  • que la consultation soit enregistrée sur notre plateforme ;
  • que vous possédiez un identifiant pour votre place de marché ;
  • que vous possédiez l'id de la candidature.

Protection par code PIN

La consultation sur la plateforme est enregistrée avec une adresse email de contact, adresse nécessaire afin de récupérer par email un code PIN permettant de visionner les candidatures à la consultation.

Ce code PIN, généré à la création de la consultation, est un numéro constitué de 4 chiffres. Lorsque celui-ci est entré, la session est valable pendant 24h, au delà il faut se re-identifier.

Il est possible de récupérer ce code PIN de manière automatique via l'API, et de le passer dans les paramètres pour consulter les candidatures. Plus de détails dans la section Récupération du code PIN d'une consultation via l'API .

Implémentation

Le format du lien est le suivant : /acheteur/candidatures/:candidature_id/pieces_justificatives avec les paramètre suivants :

  • candidature_id L'id de la candidature. Ce paramètre est à placer dans l'url à la place de :candidature_id .
  • place_id L'identifiant de votre place de marché
  • pin Le code PIN de la consultation. Ce paramètre est optionnel et permet d'effectuer une authentification automatique.

On obtient donc pour l'iframe : /iframe/acheteur/candidatures/:candidature_id/pieces_justificatives et pour la redirection : /redirection/acheteur/candidatures/:candidature_id/pieces_justificatives

Vous trouverez un exemple à l'adresse suivante : https://test.apientreprise.fr/embed_acheteur/pj_id.html


Intégration de l'embed pour les acheteurs : visionnage des pièces justificatives d'une candidature à l'aide d'un siret

Préambule

La section ci-dessous permet de visionner les pièces justificatives d'une candidature spécifique à une consultation, à l'aide du numéro de siret de l'entreprise candidate liée à la candidature.

Cette méthode permet seulement de récupérer les pièces justificatives de la dernière candidature effectuée par l'etablissement, contrairement à la méthode avec l'id de la candidature.

Pré-requis

Afin de pouvoir visionner les pièces justificatives d'une candidature, il faut :

  • que la consultation soit enregistrée sur notre plateforme ;
  • que vous possédiez l'identifiant de cette consultation ;
  • que vous possédiez un identifiant pour votre place de marché ;
  • que vous possédiez le numéro de siret de l'etablissement ayant émis la candidature.

Protection par code PIN

La consultation sur la plateforme est enregistrée avec une adresse email de contact, adresse nécessaire afin de récupérer par email un code PIN permettant de visionner les candidatures à la consultation.

Ce code PIN, généré à la création de la consultation, est un numéro constitué de 4 chiffres. Lorsque celui-ci est entré, la session est valable pendant 24h, au delà il faut se re-identifier.

Il est possible de récupérer ce code PIN de manière automatique via l'API, et de le passer dans les paramètres pour consulter les candidatures. Plus de détails dans la section Récupération du code PIN d'une consultation via l'API .

Implémentation

Le format du lien est le suivant : /acheteur/appels_offres/:appel_offre_id/candidatures/:siret/pieces_justificatives avec les paramètre suivants :

  • appel_offre_id L'identifiant de la consultation utilisé pour la création de celle-ci. Ce paramètre est à placer dans l'url à la place de :appel_offre_id .
  • siret Le numéro de siret de l'établissement ayant émis la candidature liée à la consultation. Ce paramètre est à placer dans l'url à la place de :siret .
  • place_id L'identifiant de votre place de marché
  • pin Le code PIN de la consultation. Ce paramètre est optionnel et permet d'effectuer une authentification automatique.

On obtient donc pour l'iframe : /iframe/acheteur/appels_offres/:appel_offre_id/candidatures/:siret/pieces_justificatives et pour la redirection : /redirection/acheteur/appels_offres/:appel_offre_id/candidatures/:siret/pieces_justificatives

Vous trouverez un exemple à l'adresse suivante : https://test.apientreprise.fr/embed_acheteur/pj_siret.html


Intégration de l'embed pour les acheteurs : visionnage des informations de l'entreprise d'une candidature à l'aide de l'id de la candidature

Préambule

La section ci-dessous permet de visionner les informations de l'entreprise d'une candidature spécifique à une consultation, à l'aide du numéro de l'id de la candidature

Pré-requis

Afin de pouvoir visionner les informations de l'entreprise d'une candidature, il faut :

  • que la consultation soit enregistrée sur notre plateforme ;
  • que vous possédiez un identifiant pour votre place de marché ;
  • que vous possédiez l'id de la candidature.

Protection par code PIN

La consultation sur la plateforme est enregistrée avec une adresse email de contact, adresse nécessaire afin de récupérer par email un code PIN permettant de visionner les candidatures à la consultation.

Ce code PIN, généré à la création de la consultation, est un numéro constitué de 4 chiffres. Lorsque celui-ci est entré, la session est valable pendant 24h, au delà il faut se re-identifier.

Il est possible de récupérer ce code PIN de manière automatique via l'API, et de le passer dans les paramètres pour consulter les candidatures. Plus de détails dans la section Récupération du code PIN d'une consultation via l'API .

Implémentation

Le format du lien est le suivant : /acheteur/candidatures/:candidature_id/informations_entreprise avec les paramètre suivants :

  • candidature_id L'id de la candidature. Ce paramètre est à placer dans l'url à la place de :candidature_id .
  • place_id L'identifiant de votre place de marché
  • pin Le code PIN de la consultation. Ce paramètre est optionnel et permet d'effectuer une authentification automatique.

On obtient donc pour l'iframe : /iframe/acheteur/candidatures/:candidature_id/informations_entreprise et pour la redirection : /redirection/acheteur/candidatures/:candidature_id/informations_entreprise

Vous trouverez un exemple à l'adresse suivante : https://test.apientreprise.fr/embed_acheteur/info_entreprise_id.html


Intégration de l'embed pour les acheteurs : visionnage des informations de l'entreprise d'une candidature à l'aide d'un siret

Préambule

La section ci-dessous permet de visionner les informations de l'entreprise d'une candidature spécifique à une consultation, à l'aide du numéro de siret de l'entreprise candidate liée à la candidature.

Pré-requis

Afin de pouvoir visionner les informations de l'entreprise, il faut :

  • que la consultation soit enregistrée sur notre plateforme ;
  • que vous possédiez l'identifiant de cette consultation ;
  • que vous possédiez un identifiant pour votre place de marché ;
  • que vous possédiez le numéro de siret de l'etablissement ayant émis la candidature.

Protection par code PIN

La consultation sur la plateforme est enregistrée avec une adresse email de contact, adresse nécessaire afin de récupérer par email un code PIN permettant de visionner les candidatures à la consultation.

Ce code PIN, généré à la création de la consultation, est un numéro constitué de 4 chiffres. Lorsque celui-ci est entré, la session est valable pendant 24h, au delà il faut se re-identifier.

Il est possible de récupérer ce code PIN de manière automatique via l'API, et de le passer dans les paramètres pour consulter les candidatures. Plus de détails dans la section Récupération du code PIN d'une consultation via l'API .

Implémentation

Le format du lien est le suivant : /acheteur/appels_offres/:appel_offre_id/candidatures/:siret/informations_entreprise avec les paramètre suivants :

  • appel_offre_id L'identifiant de la consultation utilisé pour la création de celle-ci. Ce paramètre est à placer dans l'url à la place de :appel_offre_id .
  • siret Le numéro de siret de l'établissement ayant émis la candidature liée à la consultation. Ce paramètre est à placer dans l'url à la place de :siret .
  • place_id L'identifiant de votre place de marché
  • pin Le code PIN de la consultation. Ce paramètre est optionnel et permet d'effectuer une authentification automatique.

On obtient donc pour l'iframe : /iframe/acheteur/appels_offres/:appel_offre_id/candidatures/:siret/informations_entreprise et pour la redirection : /redirection/acheteur/appels_offres/:appel_offre_id/candidatures/:siret/informations_entreprise

Vous trouverez un exemple à l'adresse suivante : https://test.apientreprise.fr/embed_acheteur/info_entreprise_siret.html


Récupération du code PIN d'une consultation via l'API

Préambule

La section ci-dessous décrit la procédure pour récupérer le code PIN d'une consultation de manière automatique via l'API de MPS.

Pré-requis

Il faut pouvoir interagir avec la plateforme en tant que place de marché, et donc obtenir des identifiants auprès du SGMAP.

Dans l'espace des places de marché, un jeton d'authentication est présent, il faudra l'utiliser pour pouvoir interagir avec l'API. Ce jeton vous est attribué et ne change pas.

Implémentation

Le format du lien est le suivant : /api/v1/places/appels_offres/:appel_offre_id/password

Il est possible de récupérer le code pin de la consultation soit avec l'identifiant récupéré à la création de celle-ci, soit avec l'identifiant externe utilisé à la création de cette dernière (slug)

Récupération à partir de l'identifiant de la consultation
Il faut effectuer une requête GET avec les paramètres suivants :
  • appel_offre_id l'identifiant de la consultation récupéré lors de la création de celle-ci ;
  • auth_token le jeton d'authentification de votre place de marché.
Exemple :
curl -X GET "https://mps.apientreprise.fr/api/v1/places/2341/password?auth_token=MON_TOKEN"
Récupération à partir de l'identifiant externe (provenant de la place de marché) de la consultation

Il faut effectuer une requête GET avec les paramètres suivant :

  • appel_offre_id l'identifiant de la consultation externe (provenant de la place de marché) utilisé pour créer la consultation sur la plateforme MPS
  • auth_token le jeton d'authentification de votre place de marché.
  • external_id à la valeur true pour indiquer que c'est un identifiant externe

Exemple :

curl -X GET "https://mps.apientreprise.fr/api/v1/places/ext_DZ_2341/password?auth_token=mon_token&external_id=true"

Si la requête a été effectuée avec succès, le serveur renvoi 200 avec le modèle contenant uniquement le code pin, avec la clé pin .

Si la requête échoue car la consultation n'existe pas, le serveur renvoi 404.


Passage en production

Préambule

La section ci-dessous décrit les différentes étapes pour passer en production ainsi que les validations qui interviennent.

Pré-requis

Il faut auparavant s'être assuré

  • d'avoir testé sur la plateforme de pré-production
  • avoir lu, accepté et signé la charte MPS

Implémentation

Le passage en production ne nécessite pas beaucoup de changements, il faut néanmoins

  • Demander la création d'un compte de production
    Ce compte sera lié à une adresse mail au format mps@maplacedemarche.com que vous mentionerez dans votre demande. Cette étape est importante et vous permet de séparer les mails générés pour les tests des mails de prod. Le format est imposé pour standardiser les processus. Si votre domaine email est géré séparément de votre domaine pricipal, créer l'adresse sur celui-ci. La demande de création s'effectue par mail à tech@apientreprise.fr
  • Changer le domaine des requêtes
    de mps-dev.apientreprise vers mps.apientreprise
  • Changer votre place_id dans les requêtes
    que vous faites a notre plateforme, celui-ci vous est fourni ainsi que votre mot de passe de place dans un mail qui confirme votre création de compte de production. Si vous ne recevez pas ce mail, il a probablement du être bloqué par votre client ou serveur email. L'expéditeur est tech@apientreprise.fr et l'adresse d'expédition est mps@maplacedemarche.com comme mentionné précédemment.
  • Reconfigurer l'adresse de votre flux RSS pour le moissonnage des offres
    Les données étant hermétiques entre la production et la pré production, il est nécessaire de réinsérer ce flux. Pour rappel la fréquence de moissonnage est de 30 minutes. Il suffit de se connecter à son espace places avec le mot de passe fourni lors de la création du compte

Configurations supportées

Ce service est prévu pour fonctionner sur :

  • les versions 9 ou supérieures d'Internet Explorer (sur windows 7 ou plus)
  • les versions 7 ou supérieures d’Opera
  • les versions 1.2 ou supérieures de Mozilla
  • les versions 17 ou supérieures de Firefox
  • les versions 2.0 ou supérieures de Safari
Internet Explorer 8 sous windows XP n'est pas supporté pour des questions de sécurités.

Documention de l'API ENTREPRISE

Préambule

Cette API permet de récupérer des informations sur des entreprises et établissements françaises (ie possédant des numéros de SIRET / SIREN).

Le lien de la documentation se trouve à l'adresse suivante : Lien de la documentation