API FLATBAY

Divers

• l'organisme de gli doit fournir url afin que flatbay lui communique des informations.
  (il doit etre stockée dans le champs gliUrl dans la table etablissement de flatbay)

• A l'inverse, afin que l'organisme de gli puisse communiquer a flatbay des informations de façon authentifiée, flatbay doit lui fournir une clé d'api. (elle doit etre générée et stockée dans la table etablissement.gliKey de flatbay)

• Pour convertir les exemple curl fourni en php ce site peut etre utilisé : https://incarnate.github.io/curl-to-php/

1. Envoi du dossier de candidature à l'Assurance des Loyers Impayés (GLI)

Dans un premier temps l'agent immobilier envoie le dossier à l'organisme de GLI en cliquant sur un bouton sur flatbay.fr.

une popup apparait pour lui demander les informations qui pourraient être manquantes :

• 3 revenus mensuels net perçus (pour chaque locataire)
• Dérogation

Une fois validé, en interne cela appelle cette url :

https://flatbay.fr/fr/candidate/gli/:id

Cette url envoie un JSON en POST sur l'url convenue avec l'organisme de GLI.
Tout se passe comme si l'appel était fait ainsi :

curl -X POST https://xxxxxx \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
--data '{...}'

Exemple de JSON envoyé.

{
  "etablissement": {
    "id": 1,
    "type": "etablissement.type.immo",
    "name": "FlatnYou",
    "phone": "+33975213639",
    "email": "contact@flatnyou.com",
    "description": "Depuis 2015, FlatnYou démocratise l'habitat partagé pour faciliter l’accès des jeunes au logement. \r\n\r\nLa société aménage puis gère des espaces de vie à Paris, en 1ère couronne et à Lyon.",
    "web": "http://www.flatnyou.com",
    "address": "46 Rue René Clair",
    "cp": "75018",
    "city": "Paris",
    "lng": "2.3543054",
    "lat": "48.89371419999999",
    "siegeAddress": "21 Rue Berzélius",
    "siegeCp": "75017",
    "siegeCity": "Paris",
    "activity": "etablissement.activity.gestion_and_transaction",
    "siret": "80376072700039",
    "ape": "6832A"
  },
  "property": {
    "id": 69,
    "address": "xxxxxxxxx",
    "cp": "93400",
    "city": "Saint-Ouen",
    "loyer": 1547.19,
    "charge": 345.99,
    "etablissementId": 1,
    "userId": 46,
  },
  "candidate": {
    "id": 13687,
    "type": "candidate.type.seul",
    "propertyId": 69
  },
  "gestionnaire": {
    "firstname": "Léa",
    "lastName": "L.",
    "phone": "+333333"
  },
  "commercial": {
    "firstname": "Léa",
    "lastName": "L.",
    "phone": "+333333"
  },
  "users": [
    {
      "id": 23145,
      "type": "user.type.user",
      "civility": "user.civility.m",
      "firstName": "xxxxxxxxxx",
      "lastName": "xxxxxx",
      "email": "xxxxxxxxxx@yahoo.com",
      "phone": "+3333333",
      "birthDate": "1995-05-22T22:00:00.000Z",
      "revenu": 633,
      "proprietaire": null,
      "locataire": null,
      "situation": "user.situation.salarieCDIValidee",
      "situationEtudiant": null,
      "situationSalarie": "user.situationSalarie.cdd",
      "situationAutre": null,
      "groupe": "user.groupe.seul",
      "nationality": "Italie",
      "fonction": "Stagiaire",
      "profession": null,
      "activiteDebut": "2021-04-05T22:00:00.000Z",
      "activiteFin": "2021-10-05T22:00:00.000Z",
      "essaiFin": null,
      "debut": null,
      "revenu1": 633,
      "revenuName1": "user.revenu.gratification",
      "revenu2": null,
      "revenuName2": null,
      "revenu3": null,
      "revenuName3": null,
      "revenu4": null,
      "revenuName4": null,
      "address": null,
      "cp": null,
      "city": null,
      "referentId": null,
      "referentType": null,
      "referentStructure": null,
      "organismeName": null,
      "n2": null,
      "actuellement": "user.actuellement.heberge",
      "deleteAlertAt": null,
      "situationSansEmploi": null,
      "sansemploiFin": null,
      "documents": [
        {
          "id": 160800,
          "type": "document.type.identite",
          "url": "https://flatbay.fr/fr/xxxxxxxxx"
        },
        {
          "id": 163743,
          "type": "document.type.employeur",
          "url": "https://flatbay.fr/fr/xxxxxxxxx"
        },
        {
          "id": 163747,
          "type": "document.type.contrat",
          "url": "https://flatbay.fr/fr/xxxxxxxxx"
        },
        {
          "id": 163748,
          "type": "document.type.contrat",
          "url": "https://flatbay.fr/fr/xxxxxxxxx"
        },
        {
          "id": 163749,
          "type": "document.type.contrat",
          "url": "https://flatbay.fr/fr/xxxxxxxxx"
        },
        {
          "id": 164809,
          "type": "document.type.domicile",
          "url": "https://flatbay.fr/fr/xxxxxxxxx"
        },
        {
          "id": 164810,
          "type": "document.type.domicile",
          "url": "https://flatbay.fr/fr/xxxxxxxxx"
        },
        {
          "id": 164811,
          "type": "document.type.domicile",
          "url": "https://flatbay.fr/fr/xxxxxxxxx"
        },
        {
          "id": 164812,
          "type": "document.type.domicile",
          "url": "https://flatbay.fr/fr/xxxxxxxxx"
        }
      ],
      "garants": [
        {
          "id": 23894,
          "address": "xxxxxxxxxxxxx",
          "cp": "06800",
          "city": "Cagnes-sur-Mer",
          "type": "user.type.pro",
          "civility": "user.civility.m",
          "firstName": "xxxx",
          "lastName": "xxxxxx",
          "email": "xxxxxxxxxx@wanadoo.fr",
          "phone": "+3333333333",
          "birthDate": null,
          "revenu": 1400,
          "proprietaire": null,
          "locataire": null,
          "situation": "user.situation.retraite",
          "situationEtudiant": null,
          "situationSalarie": null,
          "situationAutre": null,
          "groupe": null,
          "parente": null,
          "nationality": "France",
          "fonction": null,
          "profession": null,
          "activiteDebut": null,
          "activiteFin": null,
          "essaiFin": null,
          "debut": null,
          "revenu1": 1400,
          "revenuName1": "user.revenu.retraite",
          "revenu2": null,
          "revenuName2": null,
          "revenu3": null,
          "revenuName3": null,
          "revenu4": null,
          "revenuName4": null,
          "referentId": null,
          "referentType": null,
          "referentStructure": null,
          "organismeName": null,
          "n2": null,
          "actuellement": null,
          "deleteAlertAt": null,
          "situationSansEmploi": null,
          "sansemploiFin": null,
          "documents": [
            {
              "id": 164759,
              "type": "document.type.identite",
              "url": "https://flatbay.fr/fr/xxxxxxx"
            },
            {
              "id": 164767,
              "type": "document.type.impot",
              "url": "https://flatbay.fr/fr/xxxxxxx"
            },
            {
              "id": 164770,
              "type": "document.type.impot",
              "url": "https://flatbay.fr/fr/xxxxxxx"
            },
            {
              "id": 164799,
              "type": "document.type.retraite",
              "url": "https://flatbay.fr/fr/xxxxxxx"
            },
            {
              "id": 164838,
              "type": "document.type.foncier",
              "url": "https://flatbay.fr/fr/xxxxxxx"
            },
            {
              "id": 164839,
              "type": "document.type.foncier",
              "url": "https://flatbay.fr/fr/xxxxxxx"
            },
            {
              "id": 164872,
              "type": "document.type.domicile",
              "url": "https://flatbay.fr/fr/xxxxxxx"
            }
          ]
        }
      ]
    }
  ]
}

2. Retour d'information sur le dossier

l'organisme de gli peut appeller cette url afin de notifier flatbay du status du dossier.

• X-API-KEY (header) : la clé d'api devra etre tranmise via un header HTTP.
• candidateId (body) : L'id est censé etre l'id de candidature récupéré précedement dans le json.
• status (body) : Les status acceptés sont "ok" ou "ko" ou "need_data"
• message (body) : En cas de status == need_data, cela permet de rédiger un texte dans lequel sera detaillé les pièces et/ou la personne pour laquelle il faut des precisions.
• files (body) : tableau de fichiers. un fichier est un objet avec un champs "content" qui contient le contenu du fichier en base64, et un champs "name" contenant le nom du fichier avec l'extension. On peut spécifier plusieurs fichiers. ils seront tous visibles dans l'interface de flatbay.

Exemple de demande d'information :

curl -X POST https://flatbay.fr/fr/glihook \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-API-KEY: xxxxxxx" \
--data '{"candidateId": 12345, "status":"need_data", "message": "piece d'identité de Raphaël Piccolo illisible"}'

Exemple d'accord avec fichiers :

curl -X POST https://flatbay.fr/fr/glihook \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-API-KEY: xxxxxxx" \
--data '{"candidateId": 12345, "status":"ok", "files": [{"content":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==", "name":"file.pdf"}]}'

Dictionnaire