Créer des candidatures

cURL

curl --request POST \
  --url https://flatbay.fr/fr/api/candidates/create/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "users": [
    {
      "firstName": "Jean",
      "lastName": "Dupont",
      "email": "jean.dupont@example.com",
      "phone": "+33612345678",
      "civility": "user.civility.m",
      "birthDate": "1990-01-15",
      "nationality": "FR",
      "situationfamiliale": "user.situationfamiliale.celib",
      "groupe": "user.groupe.seul",
      "optin": "1"
    }
  ]
}
'

import requests

url = "https://flatbay.fr/fr/api/candidates/create/{id}"

payload = { "users": [
        {
            "firstName": "Jean",
            "lastName": "Dupont",
            "email": "jean.dupont@example.com",
            "phone": "+33612345678",
            "civility": "user.civility.m",
            "birthDate": "1990-01-15",
            "nationality": "FR",
            "situationfamiliale": "user.situationfamiliale.celib",
            "groupe": "user.groupe.seul",
            "optin": "1"
        }
    ] }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    users: [
      {
        firstName: 'Jean',
        lastName: 'Dupont',
        email: 'jean.dupont@example.com',
        phone: '+33612345678',
        civility: 'user.civility.m',
        birthDate: '1990-01-15',
        nationality: 'FR',
        situationfamiliale: 'user.situationfamiliale.celib',
        groupe: 'user.groupe.seul',
        optin: '1'
      }
    ]
  })
};

fetch('https://flatbay.fr/fr/api/candidates/create/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://flatbay.fr/fr/api/candidates/create/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'users' => [
        [
                'firstName' => 'Jean',
                'lastName' => 'Dupont',
                'email' => 'jean.dupont@example.com',
                'phone' => '+33612345678',
                'civility' => 'user.civility.m',
                'birthDate' => '1990-01-15',
                'nationality' => 'FR',
                'situationfamiliale' => 'user.situationfamiliale.celib',
                'groupe' => 'user.groupe.seul',
                'optin' => '1'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://flatbay.fr/fr/api/candidates/create/{id}"

	payload := strings.NewReader("{\n  \"users\": [\n    {\n      \"firstName\": \"Jean\",\n      \"lastName\": \"Dupont\",\n      \"email\": \"jean.dupont@example.com\",\n      \"phone\": \"+33612345678\",\n      \"civility\": \"user.civility.m\",\n      \"birthDate\": \"1990-01-15\",\n      \"nationality\": \"FR\",\n      \"situationfamiliale\": \"user.situationfamiliale.celib\",\n      \"groupe\": \"user.groupe.seul\",\n      \"optin\": \"1\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://flatbay.fr/fr/api/candidates/create/{id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"users\": [\n    {\n      \"firstName\": \"Jean\",\n      \"lastName\": \"Dupont\",\n      \"email\": \"jean.dupont@example.com\",\n      \"phone\": \"+33612345678\",\n      \"civility\": \"user.civility.m\",\n      \"birthDate\": \"1990-01-15\",\n      \"nationality\": \"FR\",\n      \"situationfamiliale\": \"user.situationfamiliale.celib\",\n      \"groupe\": \"user.groupe.seul\",\n      \"optin\": \"1\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flatbay.fr/fr/api/candidates/create/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"users\": [\n    {\n      \"firstName\": \"Jean\",\n      \"lastName\": \"Dupont\",\n      \"email\": \"jean.dupont@example.com\",\n      \"phone\": \"+33612345678\",\n      \"civility\": \"user.civility.m\",\n      \"birthDate\": \"1990-01-15\",\n      \"nationality\": \"FR\",\n      \"situationfamiliale\": \"user.situationfamiliale.celib\",\n      \"groupe\": \"user.groupe.seul\",\n      \"optin\": \"1\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "status": "ok"
}

{
  "error": "<string>"
}

POST

candidates

create

{id}

cURL

curl --request POST \
  --url https://flatbay.fr/fr/api/candidates/create/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "users": [
    {
      "firstName": "Jean",
      "lastName": "Dupont",
      "email": "jean.dupont@example.com",
      "phone": "+33612345678",
      "civility": "user.civility.m",
      "birthDate": "1990-01-15",
      "nationality": "FR",
      "situationfamiliale": "user.situationfamiliale.celib",
      "groupe": "user.groupe.seul",
      "optin": "1"
    }
  ]
}
'

import requests

url = "https://flatbay.fr/fr/api/candidates/create/{id}"

payload = { "users": [
        {
            "firstName": "Jean",
            "lastName": "Dupont",
            "email": "jean.dupont@example.com",
            "phone": "+33612345678",
            "civility": "user.civility.m",
            "birthDate": "1990-01-15",
            "nationality": "FR",
            "situationfamiliale": "user.situationfamiliale.celib",
            "groupe": "user.groupe.seul",
            "optin": "1"
        }
    ] }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    users: [
      {
        firstName: 'Jean',
        lastName: 'Dupont',
        email: 'jean.dupont@example.com',
        phone: '+33612345678',
        civility: 'user.civility.m',
        birthDate: '1990-01-15',
        nationality: 'FR',
        situationfamiliale: 'user.situationfamiliale.celib',
        groupe: 'user.groupe.seul',
        optin: '1'
      }
    ]
  })
};

fetch('https://flatbay.fr/fr/api/candidates/create/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://flatbay.fr/fr/api/candidates/create/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'users' => [
        [
                'firstName' => 'Jean',
                'lastName' => 'Dupont',
                'email' => 'jean.dupont@example.com',
                'phone' => '+33612345678',
                'civility' => 'user.civility.m',
                'birthDate' => '1990-01-15',
                'nationality' => 'FR',
                'situationfamiliale' => 'user.situationfamiliale.celib',
                'groupe' => 'user.groupe.seul',
                'optin' => '1'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://flatbay.fr/fr/api/candidates/create/{id}"

	payload := strings.NewReader("{\n  \"users\": [\n    {\n      \"firstName\": \"Jean\",\n      \"lastName\": \"Dupont\",\n      \"email\": \"jean.dupont@example.com\",\n      \"phone\": \"+33612345678\",\n      \"civility\": \"user.civility.m\",\n      \"birthDate\": \"1990-01-15\",\n      \"nationality\": \"FR\",\n      \"situationfamiliale\": \"user.situationfamiliale.celib\",\n      \"groupe\": \"user.groupe.seul\",\n      \"optin\": \"1\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://flatbay.fr/fr/api/candidates/create/{id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"users\": [\n    {\n      \"firstName\": \"Jean\",\n      \"lastName\": \"Dupont\",\n      \"email\": \"jean.dupont@example.com\",\n      \"phone\": \"+33612345678\",\n      \"civility\": \"user.civility.m\",\n      \"birthDate\": \"1990-01-15\",\n      \"nationality\": \"FR\",\n      \"situationfamiliale\": \"user.situationfamiliale.celib\",\n      \"groupe\": \"user.groupe.seul\",\n      \"optin\": \"1\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flatbay.fr/fr/api/candidates/create/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"users\": [\n    {\n      \"firstName\": \"Jean\",\n      \"lastName\": \"Dupont\",\n      \"email\": \"jean.dupont@example.com\",\n      \"phone\": \"+33612345678\",\n      \"civility\": \"user.civility.m\",\n      \"birthDate\": \"1990-01-15\",\n      \"nationality\": \"FR\",\n      \"situationfamiliale\": \"user.situationfamiliale.celib\",\n      \"groupe\": \"user.groupe.seul\",\n      \"optin\": \"1\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "status": "ok"
}

{
  "error": "<string>"
}

Endpoint

POST /api/candidates/create/:id?apiKey=xxxxx

Il faudra que l’équipe Flatbay vous fournisse une clé API pour utiliser cette route.

Description

Cette route permet de créer une ou plusieurs candidatures pour un bien donné. Pour chaque utilisateur dans le tableau users, une candidature sera créée avec:

Statut: candidate.status.demande (Non traitée)
Type: candidate.type.seul (Seul)
Candidate: 0 (prospect)

Paramètres

Path Parameter

Paramètre	Type	Requis	Description
`id`	integer	Oui	Identifiant de la propriété

Query Parameters

Paramètre	Type	Requis	Description
`apiKey`	string	Oui	Votre clé API
`roomId`	integer	Non	Identifiant de la chambre (colocation)

Corps de la requête

Champ	Type	Requis	Description
`users`	array	Oui	Liste des utilisateurs à créer

Champs utilisateur

Champ	Type	Description
`firstName`	string	Prénom
`lastName`	string	Nom
`email`	string	Email
`phone`	string	Téléphone
`civility`	string	Civilité (user.civility.m, user.civility.mme, user.civility.other)
`birthDate`	string	Date de naissance (YYYY-MM-DD)
`nationality`	string	Nationalité (code pays)
`situationfamiliale`	string	Situation familiale
`groupe`	string	Groupe
`optin`	string	”1” pour activer l’opt-in marketing

Valeurs possibles pour situationfamiliale

user.situationfamiliale.celib - Célibataire
user.situationfamiliale.concub - Concubin
user.situationfamiliale.marie - Marié(e)
user.situationfamiliale.div - Divorcé(e)
user.situationfamiliale.veuf - Veuf(ve)
user.situationfamiliale.pacse - Pacsé(e)

Valeurs possibles pour groupe

user.groupe.seul - Seul
user.groupe.couple - Couple
user.groupe.groupe - Groupe
user.groupe.personne.morale - Personne morale

Exemple de requête

{
    "users": [
        {
            "firstName": "Jean",
            "lastName": "Dupont",
            "email": "jean.dupont@example.com",
            "phone": "+33612345678",
            "civility": "user.civility.m",
            "birthDate": "1990-01-15",
            "nationality": "FR",
            "situationfamiliale": "user.situationfamiliale.celib",
            "groupe": "user.groupe.seul",
            "optin": "1"
        }
    ]
}

Réponse

{
    "status": "ok"
}

Path Parameters

enum<integer>

required

Identifiant de la propriété pour laquelle créer les candidatures Identifiant du bien

Available options:

1,

3,

4,

5,

6,

7,

8,

9,

10

Example:

1

Query Parameters

apiKey

string

required

Mot de passe pour l'accès sécurisé

Example:

"api_key_here"

roomId

integer

Identifiant de la chambre (pour les colocations avec bail individuel) Id de la chambre

Example:

1

Body

application/json

Liste des utilisateurs à ajouter comme candidats

users

object[]

required

Liste des utilisateurs à ajouter comme candidats

Minimum array length: 1

Show child attributes

Response

Candidatures créées avec succès

Retour positif du serveur

status

string

Statut de la requête

Example:

"ok"

​Endpoint

​Description

​Paramètres

​Path Parameter

​Query Parameters

​Corps de la requête

​Champs utilisateur

​Valeurs possibles pour situationfamiliale

​Valeurs possibles pour groupe

​Exemple de requête

​Réponse

Path Parameters

Query Parameters

Body

Response

Endpoint

Description

Paramètres

Path Parameter

Query Parameters

Corps de la requête

Champs utilisateur

Valeurs possibles pour situationfamiliale

Valeurs possibles pour groupe

Exemple de requête

Réponse