Devenir partenaire
Documentation Technique : le coin des développeurs
🔗
Lien tracké (deprecated)
Difficulté d'intégration : 1/10 - Attention ! Pour les nouveaux partenaires, à ne pas utiliser.
Prérequis techniques :
- Avoir un espace login sur votre plateforme pour les utilisateurs
- Pouvoir mettre en place un webhook
Étape 1 : la Charte du partenaire
Avant d'installer le lien tracké sur votre site internet, assurez-vous de nous avoir retourné la charte du partenaire remplie et signée. Si ce n'est pas encore fait, vous pouvez la télécharger ci-dessous
⤵
Charte DossierFacile.pdf
92KB
PDF
Vous pouvez la transmettre à :
Clara Dumont : [email protected]
Boutié Camara : [email protected]
Arthur Hatchuel : [email protected]
🔵
🔵
🔵
Étape 2 : la création de votre URL de callback
Le lien tracké est un lien mis en place sur votre application vers DossierFacile permettant à DossierFacile de comprendre que l’utilisateur provient de chez vous. Il y a ainsi un échange d'informations entre nos services puisque des "callbacks" vous sont envoyés lors de certaines actions de l'utilisateur, une fois que ce dernier s'est connecté à DossierFacile depuis votre plateforme. Ainsi, l'utilisateur de votre application est lié via un webhook.
Il vous faut donc nous fournir cette URL de callback sur laquelle sera envoyée le DossierFacile à la validation.
Étape 3 : la création du lien-bouton
Voici le format du lien-bouton :
1
https://locataire.dossierfacile.fr/source/SOURCE_NAME?firstName=XXXX&lastName=XXXX&[email protected]&internalPartnerId=XXXXXXX
Copied!
SOURCE_NAME = il s'agit du nom de votre organisme que l'on renseigne une fois que nous avons créé votre compte dans notre basefirstName
lastName
email
internalPartnerId = il s'agit d'un ID à vous si vous le souhaitez, qui sera présent dans le callback pour une meilleure identificationIl est aussi possible d'ajouter une clé de sécurité à l'appel de votre URL de callback qu'il faudra nous transmettre le cas échéant.
Le webhook : déclenchements et format
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 :
1
Requête POST sur l'URL prédéfinie contenant le body JSON :
2
A la validation
3
{
4
tenantsEmails:[]
5
url:"" ## cette url est l'url du DossierFacile de
6
la colocation
7
}
8
tenantsEmail (la liste des emails d'un même dossier (en cas de
9
colocation)
10
url : l'url du dossier complet)
11
A la suppression
12
{
13
tenantsEmails:[]
14
status:"DELETED"
15
}
Copied!
Téléchargez le JSON du callback ci-dessous :
⤵
2-callback_version2.json
4KB
Code
Faire une simulation
Faites une simulation afin de visualiser le parcours de vos internautes et voir le format du callback lors de 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.
L'utilisateur a ensuite deux options :
- se créer un compte
- lier un compte déjà existant
Vous pouvez ensuite retrouver un exemple du callback envoyé lors de la création du compte en cliquant sur "Voir les évènements reçus".
Téléchargez une présentation détaillée de l'intégration technique
Intégration technique DossierFacile _ Lien Tracké.pdf
707KB
PDF