🔗
DossierFacile Connect
Difficulté d'intégration : 3/10

En quoi consiste le DossierFacile Connect ?

DossierFacile Connect est la solution single sign-on (SSO) de DossierFacile.
Il s'agit d'une fenêtre de login/signup de DossierFacile qui est intégrée à votre plateforme. L’utilisateur peut alors se connecter à DossierFacile depuis votre site et une liaison est ainsi faite entre votre plateforme et un compte existant sur DossierFacile.
Ce faisant l'utilisateur consent à ce que le partenaire ait accès à un certain nombre d’informations relatives à son compte chez DossierFacile.

Prérequis techniques

  • Avoir un espace login sur votre plateforme pour les utilisateurs
  • Connaissance de Postman
  • Pouvoir mettre en place un webhook (optionnel)

Télécharger la présentation

DossierFacile - Presentation_DossierFacile_Connect.pdf
1MB
PDF

Visionner la présentation technique par le développeur

Le parcours des usagers

Le bouton DossierFacile Connect

Téléchargez le bouton à implémenter
DossierFacileConnect_v0.9.zip
46KB
Binary
Aperçu du bouton DossierFacile Connect
Ajoutez le court texte de présentation suivant.
DossierFacile est le dossier de location numérique de l'Etat. Entièrement gratuit, conforme et sécurisé, il protège les locataires et rassure les propriétaires.

Le principe du SSO

Testez le DossierFacile Connect avec Postman (environnement bac à sable)

DossierFacile Connect est un système vous permettant de récupérer les informations du dossier de location d’un de vos utilisateurs directement sur votre plateforme. Il permet également de mettre en place un webhook vous indiquant quand le statut d’un dossier change.
Ce tutoriel décrit les différentes étapes de l’utilisation via Postman.
L’objectif de l’opération est de pouvoir appeler le endpoint https://api-dev.dossierfacile.fr/dfc/tenant/profile qui contient les informations du dossier de location de l’utilisateur.

1 - Création d’une requête dans Postman

Créez un endpoint GET sur l’URL https://api-dev.dossierfacile.fr/dfc/tenant/profile

2 - Configuration de l’authentification dans Postman

Configurez l’authentification de Postman en Oauth 2.0 puis configurez un nouveau token avec les valeurs suivantes.
Token Name
oauth2 keycloack
Grant Type
Authorization Code
Callback URL
https://locataire-dev.dossierfacile.fr
Authorize using browser
non coché
Auth URL
https://sso-preprod.dossierfacile.fr/auth/realms/dossier-facile/protocol/openid-connect/auth
Access Token URL
https://sso-preprod.dossierfacile.fr/auth/realms/dossier-facile/protocol/openid-connect/token
Client ID
dfc-test-client
Client Secret
Scope
openid
State
Client Authentication
Send as Basic Auth header
Cliquez ensuite sur Get New Access Token, une fenêtre d’identification DossierFacile va s’ouvrir.
Renseignez les champs avec les identifiants d’un compte créé préalablement sur https://locataire-dev.dossierfacile.fr
Cliquez ensuite sur Use Token

3 - Et enfin lancez la requête Postman

4 - Optionnel 1 : utilisation du refresh token

Il existe dans la réponse à l’authentification un refresh token, qui permet de générer un nouveau token d’authentification afin d’accéder au endpoint /dfc/tenant/profile à nouveau sans demander à l’utilisateur de se reconnecter.
curl --location --request POST https://sso-preprod.dossierfacile.fr/auth/realms/dossier-facile/protocol/openid-connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=refresh_token' \
--data-urlencode 'client_id=dfc-locservice' \
--data-urlencode 'refresh_token={REFRESH TOKEN VALUE}'

5 - Optionnel 2 : webhooks

Il est possible de configurer un webhook afin qu’une fois qu’un utilisateur s’est loggé à DossierFacile depuis votre plateforme, vous receviez les changements de statuts de son dossier.
Une fois que l'utilisateur s'est loggé à DossierFacile depuis votre plateforme, vous recevez les modifications des statuts sur l'URL de callback. Cela s'opère dès lors que l'utilisateur effectue l'une des actions suivantes :
  • complète son dossier
  • valide son compte
  • supprime son compte.
Le format du callback :
Requête POST sur l'URL prédéfinie contenant le body JSON :
A la validation
{
tenantsEmails:[]
url:"" ## cette url est l'url du DossierFacile de
la colocation
}
tenantsEmail (la liste des emails d'un même dossier (en cas de
colocation)
url : l'url du dossier complet)
A la suppression
{
tenantsEmails:[]
status:"DELETED"
}
Téléchargez le JSON du callback ci-dessous :
2-callback_version2.json
4KB
Code

6 - Faites une simulation afin de visualiser le parcours de vos internautes et voir le format du callback lors de la création de compte.

Rendez-vous sur la plateforme de simulation suivante :
https://demo-partenaire.dossierfacile.fr
demo-partenaire.dossierfacile.fr
Renseignez les informations de connexion (email / nom / prénom / ID partenaire : facultatif) puis cliquez sur "Envoyer". Cette étape correspond à ce que l'utilisateur verrait sur votre plateforme avant d'être renvoyé vers notre service.
Vous arrivez sur la page de liaison sur laquelle vous avez deux options :
  • créer un compte
  • lier un compte existant
Retrouvez ensuite un exemple du callback envoyé lors de la création du compte en cliquant sur "Voir les évènements reçus".

Faire une demande de credentials

Pour récupérer des identifiants de préproduction, écrivez à un membre de l'équipe pour être mis en relation avec un développeur. Échanger avec un membre de l'équipe
Pensez à bien indiquer dans le mail vos URLs de redirection et vos URLs de webhook si vous voulez utiliser les webhooks (voir5-optionnel-2-webhook).
Il faut d'abord utiliser les identifiants de la documentation pour tester la connexion et travailler depuis un poste local (cf URL de callback en localhost).
Lors de la demande d'un accès privé en preprod et/ou prod il faut fournir l'URL de callback (non localhost) et l'URL de webhook à utiliser.

Prendre rendez-vous pour plus d'informations

Copy link
Outline
En quoi consiste le DossierFacile Connect ?
Le parcours des usagers
Le bouton DossierFacile Connect
Le principe du SSO
Testez le DossierFacile Connect avec Postman (environnement bac à sable)
1 - Création d’une requête dans Postman
2 - Configuration de l’authentification dans Postman
3 - Et enfin lancez la requête Postman
4 - Optionnel 1 : utilisation du refresh token
5 - Optionnel 2 : webhooks
6 - Faites une simulation afin de visualiser le parcours de vos internautes et voir le format du callback lors de la création de compte.
Faire une demande de credentials
Prendre rendez-vous pour plus d'informations