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 la rubrique « Cas d’usage » > « Transmettre un dossier de financement » qui sont plus détaillées.
Pré-requis
- Le partenaire doit signer une convention de partenariat avec l’établissement, ou la banque
- L’éditeur doit délivrer un certificat qu’il aura demandé et obtenu préalablement à une autorité de certification reconnue ; lors de la demande de GO-LIVE (validation technique faite par BPCE-IT).
- Le partenaire doit obtenir ses identifiants de connexion BPCE, à partir de l’Extranet Partenaires
Cinématique globale de consommation de l’API
Création d’une application
L’API « Transmission de demandes de crédit immobilier » (ou API « Injection de données ») est privée : vous devez vous inscrire sur le portail en créant un compte professionnel (sélectionnez « développements professionnels » dans la liste proposée).
La création de votre compte professionnel fait l’objet d’une validation par l’équipe Portail BPCE (délai J+1 ouvré)
Vous devez, à partir du menu « Application », créer votre application concernant l’API « Injection de données » :
A la validation, vous arrivez sur l’onglet de gestion des identifiants de l’application :
Il faut générer l’identifiant OAuth (la clé d’APIs est inutile pour votre cas) en cliquant sur le bouton « Générer », il vous permet de récupérer l’IDClient et de préciser l’URL de redirection (qui doit être fournie par le partenaire) :
Vous devez fournir l’URL de redirection :
Vous devez identifier la clé secrète en cliquant sur le symbole identifié dans l’écran portail , onglet authentification, ligne identifiants OAuth :
Demande de GoLive
Vous devez saisir une demande de GoLive (formulaire) pour consommer l’API « Transmission de demandes de crédit immobilier ».
Depuis le portail, sur notre application, vous devez cliquer sur le bouton « Demander GoLive » et vous devez remplir le formulaire demandé.
Saisie du Formulaire de demande de GoLive
Vous devez saisir des informations concernant votre entreprise et votre application.
Vous devez également télécharger la clé de votre certificat (.pem) et la joindre dans le formulaire.
Etapes de validation obligatoires suite à la demande de mise en production :
- Demande GoLive
- Validation technique (validation du certificat)
- Validation juridique (contrôle des contrats juridiques signés entre le partenaire et l’établissement/banque)
- Validation API Owner
- Etape finale
- Accès live
Récupérer votre jeton
Cinématique de récupération du jeton
1. Vous devez, dans un premier temps, récupérer l’authorization code (étape 3 du diagramme), via l’URL :
2. Les paramètres à renseigner sont décrits ci-dessous.
| PARAMÈTRES | SANDBOX | LIVE |
| URL AS | https://www.as-sandbox.api.89c3.com/api/oauth/v2/authorize | https://www.as-live.api.89c3.com/api/oauth/v2/authorize |
| client_id | A récupérer lors de la création de l’application consommatrice sur le portail | A récupérer lors de la création de l’application consommatrice sur le portail |
| login-hint | En attente provisionning ICG (mail) | En attente provisionning ICG (mail) |
| scope | manageHomeLoanPrescriber | manageHomeLoanPrescriber |
| response_type | code | code |
| redirect_uri | https://fqdnduconsommateur/callback | https://fqdnduconsommateur/callback |
| state | Donnée interne du consommateur | Donnée interne du consommateur |
| cdetab | 16188 | / |
| typ_app | template | / |
| typ_srv | PARTENAIRES | / |
| enseigne | BPCE | / |
| typ_sp | out-band | / |
| typ_act | auth | / |
| display | page | / |
3. Vous récupérerez à l’étape 8 (authentification ICG) la page index.html qu’il faudra intégrer dans un conteneur web de votre application.
4. La saisie du mot de passe (étape 9) permettra de récupérer l’authorization code. Pour rappel, la saisie de l’identifiant BPCE est un pré-requis.
5. Après l’étape 14 (récupération de l’authorization code), vous devez démarrer la procédure de récupération de l’access-token.
Vous devez tout d’abord récupérer l’access token via l’URL : https://www.as-ex-hml-89c3api.qpa.bpce.fr/api/oauth/v2/token?grant_type=authorizationCode&redirect_uri=http://www.google.fr&code=123456789&client_id=3a1022ab-7dc6-45c0-9df1-2f051a7398d5
Les paramètres à renseigner sont les suivants :
| PARAMÈTRES | SANDBOX | LIVE |
| URL AS | https://www.as-sandbox.api.89c3.com/api/oauth/v2/token | https://www.as-live.api.89c3.com/api/oauth/v2/token |
| client_id | authorizationCode | authorizationCode |
| grant_type | En attente provisionning ICG (mail) | En attente provisionning ICG (mail) |
| redirect_uri | https://fqdnduconsommateur/callback | https://fqdnduconsommateur/callback |
| client_id | A récupérer lors de la création de l’application consommatrice sur le portail | A récupérer lors de la création de l’application consommatrice sur le portail |
Console Try-it
Principe
En vous connectant sur le portail, vous pouvez :
- faire appel à l’API souhaitée via un formulaire dans lequel vous sélectionnez votre application et le jeton d’accès
- puis vous saisissez les paramètres de la méthode que vous souhaitez tester (soit headers, soit body), ceux mentionnés par une étoile étant obligatoires
Une fois les paramètres saisis, vous pouvez lancer l’exécution de la requête : vous obtiendrez soit un résultat, soit une erreur.
Après récupération de l’identifiant OAuth, aller sur l’onglet « Documentation » du produit « Injection de données ».
Sélectionner la ligne accountsGet dans le totem de gauche pour accéder au module TRY-IT.
Ouvrir le chevron TRY-IT et renseigner les zones suivantes :
- Application (ouvrir la liste déroulante) et sélectionner l’application que vous avez ajouté précédemment :
- Le client OAuth (sélectionner la clé) :
- Ressource owner (liste déroulante) :
- Saisir la signature (dans notre exemple « XX »)
- Saisir X-Request-ID (XX)
- Cliquer sur le bouton « Exécuter »