Utilisation de l'API Lease4¶
<<<<<<< HEAD Ce document décrit la séquence d'appels pour ouvrir et suivre une demande de refinancement dans Lease4. ======= Ce document décrit la séquences d'appels pour ouvrir et suivre une demande de refinancement dans Lease4.
225c995 (doc: ajoute de la documentation sur l'utilisation de l'API)
Documentation Swagger¶
La documentation technique de l'API est disponible sur https://api.{tenant}.lease4.net en production et https://test.api.{tenant}.lease4.net/docs en recette.
Authentification¶
Tous les appels doivent être accompagnés d'un jeton d'accès dans l'en-tête HTTP Authorization.
Utiliser le endpoint POST /v1/token avec votre email et mot de passe pour récupérer un jeton d'accès. Le jeton est ensuite utilisé dans les requêtes avec l'en-tête Authorization: Bearer {jeton d'accès} Attention : le endpoint traite l'authentification avec le mime type application/x-www-form-urlencoded.
Création d'une demande de refinancement¶
Une demande de refinancement se fait en renseignant plusieurs éléments :
- Un client
- Un fournisseur
- Un barème
- Une catégorie d'investissement
- Un montant d'investissement
- Une durée
- Une périodicité
- Un loyer cible ou un montant d'investissement cible
- Un ensemble de documents
L'utilisateur peut avoir un accès limité aux catégories, durées, périodicités et barèmes suivant les droits qui lui sont attribués dans le backoffice Lease4.
Récupération des barèmes¶
La récupération des barèmes se fait en appelant :
GET /v1/rategrids
Ils sont identifiés par le champ id qui devra etre renseigné dans la demande de refinancement.
Récupération des catégories d'investissement¶
Les catégories d'investissement accessibles à l'utilisateur sont récupérées par :
GET /v1/categories
Le champ id de la réponse sera utilisé pour préciser la catégorie dans la demande de refinancement.
Récupération des périodicités¶
Les périodicités de loyer accessibles à l'utilisateur sont récupérées par :
GET /v1/periodicities
Le champ id de la réponse sera utilisé pour préciser la périodicité dans la demande de refinancement.
Récupération des durées¶
Les durées de financement accessibles à l'utilisateur sont récupérées par :
GET /v1/durations
<<<<<<< HEAD Ce endpoint renvoie une liste de durées disponibles sous forme de nombres entiers. Une de ces durées devra être renseignée sur la demande de refinancement. ======= Ce endpoint renvoie une liste de durées disponibles sous forme de nombre entiers. Une de ses durée devra être renseignée sur la demande de refinancement.
225c995 (doc: ajoute de la documentation sur l'utilisation de l'API)
Récupération du client¶
Les clients sont identifiés par leur SIRET qui sera à passer dans la demande de refinancement. Il est possible de récupérer ces informations en faisant une recherche sur le siren.
GET /v1/customer?code={siren ou siret}
Récupération du fournisseur¶
Comme les clients, les fournisseurs sont identifiés par leur SIRET et peuvent être récupérés par :
GET /v1/supplier?code={siren ou siret}
Calcul des montants¶
Il est possible de calculer l'investissement en fonction du loyer ou le loyer en fonction de l'investissement en utilisant :
POST /v1/calculation
Utiliser "computedEntry": "RENT" pour calculer le loyer en fonction de l'investissement ou "computedEntry": "INVESTMENT" pour calculer l'investissement en fonction du loyer. Tous les champs doivent être renseignés quelque soit le type de calcul demandé.
Envoi d'une demande de refinancement¶
L'envoi d'une demande de refinancement se fait avec le endpoint :
POST /v1/fundingRequest
Seul le code (SIRET) est obligatoire pour identifier le customer et le supplier.
La réponse contient la référence de la demande de refinancement.
Consulter une demande de refinancement¶
Les informations d'une demande de refinancement et son état peuvent être récupérés à partir de sa référence.
GET /v1/fundingRequest/{reference}
Associer un document à une demande de refinancement¶
Récupération des types de document¶
L'association d'un document à une étude de refinancement nécessite d'identifier son type. Les types de document sont consultables au travers du endpoint :
GET /v1/documentTypes
La réponse contient un champ id qu'il faudra renseigner dans la requête d'envoi de document.
Association d'un document à une demande de refinancement¶
POST /v1/fundingRequest/{reference}/document
Le document doit être encodé en base64 pour être envoyé dans le champ filecontent.
Récupération des documents¶
Les noms et types des documents associés à une demande de refinancement peuvent être récupérés avec :
GET /v1/fundingRequest/{reference}/documents