Consommer l'API
La description des services proposés ci-après n’est que purement fonctionnelle. Les aspects techniques sont répertoriés dans les sections « Cas d’usage » qui sont plus détaillées.
➤ Prérequis
Le client doit avoir un contrat caution de marché valide avec la CEGC.
Le client doit délivrer deux certificats (client assertion et user assertion) qu’il aura demandés et obtenus préalablement à une autorité de certification reconnue ; lors de la demande de GO-LIVE (validation technique faite par BPCE-IT).
➤ Cinématique globale de consommation de l'API
Création d'une caution
Etape 1 : Le client doit s’identifier.
Etape 2 : Le client récupère la liste des agences via le web service GET /v1/clientBranches/search/bySiren afin de choisir l’agence pour laquelle il souhaiterait créer la caution. Un client peut ne pas avoir d’agence.
Etape 3 : Le client récupère la liste des contrats via le web service GET /v1/marketBondContracts/search/bysiren afin de choisir le contrat concerné par son besoin.
Etape 4 : Le client récupère la liste des modèles de texte rattachés au contrat via le web service GET /v1/bondTemplateTexts/search/byMarketBondContract afin de choisir le modèle correspondant à son besoin.
Etape 5 : Le client renseigne toutes les informations nécessaires à la création d’une caution et appelle le web service POST /v1/marketBonds/marketBondInitiate afin de créer sa caution.
Etape 6 : Le client reçoit un lien afin de télécharger son acte de garantie en temps réel.
Récupération d'une caution
Etape 1 : Le client doit s’identifier.
Etape 2 : Le client récupère la caution via le web service GET /v1/marketBonds/{marketBondId}.
Récupération d'un acte de garantie
Etape 1 : Le client doit s’identifier.
Etape 2 : Le client récupère une URL afin de télécharger l’acte de garantie via le web service POST /v1/marketBonds/{marketBondId}/prepareDownload.