Endpoint Examples
- GETListe l'ensemble des biens d'un établissement
- GETLister les annonces actives
- GETDétails d'un bien
- GETTous les biens vendus
- POSTCréer un bien
- GETSupprimer un bien
- POSTModifier un bien
- POSTAjouter une photo à un bien
- DELSupprimer une photo d'un bien
- POSTModifier une chambre dans un bien
- POSTAffecter un commercial au bien
- DELRetirer un commercial du bien
- GETTracking de vues/partages
- GETCandidatures
- GETVisites
- GETSso
Endpoint Examples
Créer un bien
Route de création d’une property
POST
/
property
/
create
Copy
curl --request POST \
--url https://flatbay.fr/fr/api/property/create \
--header 'Content-Type: application/json' \
--data '{
"archive": true,
"offmarket": true,
"smartlead": true,
"addresscache": true,
"addressCacheRadius": 123,
"notifPublicationProp": true,
"address": "<string>",
"cp": "<string>",
"city": "<string>",
"country": "France",
"lng": "<string>",
"lat": "<string>",
"type": "property.type.maison",
"type2": "property.type2.mono",
"construction": "property.construction.1946",
"rentsellType": "property.rentsellType.rent",
"annonceTitle": "<string>",
"etage": 123,
"nbEtage": 123,
"nbPiece": 123,
"nbRoom": 123,
"nbDouche": 123,
"nbDetailDouche": 123,
"nbDetailBaignoire": 123,
"nbWc": 123,
"frais": 123,
"fraisLocationBailleur": 123,
"fraisLocationBailleurApplicable": "oui",
"fraisType": "property.fraisType.vendeur",
"fraisRoom": 123,
"surface": 123,
"eautype": "property.production.collectif",
"bailType": "property.bailType.collectif",
"chauffagetype": "property.production.collectif",
"description": "<string>",
"honorairesCalcul": "property.honorairesCalcul.percent",
"percentPrix": 123,
"percentRemise": 123,
"prix": 123,
"loyer": 123,
"depot": 123,
"edlHonoraire": 123,
"edlHonoraireBailleur": 123,
"charge": 123,
"energyBillMin": 123,
"energyBillMax": 123,
"foncier": 123,
"meuble": true,
"gardien": true,
"video": true,
"gli": true,
"plaque": true,
"four": true,
"microonde": true,
"frigo": true,
"jacuzzi": true,
"hammam": true,
"sauna": true,
"clim": true,
"travaux": true,
"ravalementDate": 123,
"refectionDate": 123,
"refectionCommuneDate": 123,
"travauxDesc": "<string>",
"laveLinge": true,
"secheLinge": true,
"laveVaisselle": true,
"cafetiere": true,
"tv": true,
"fibre": true,
"codeWifi": "<string>",
"grillePain": true,
"aspirateur": true,
"bouilloire": true,
"hotte": true,
"vaisselle": true,
"linge": true,
"internet": true,
"chauffage": true,
"eauchaude": true,
"eaufroide": true,
"entretien": true,
"entretienJardin": true,
"entretienChaudiere": true,
"ordures": true,
"menage": true,
"risque": true,
"electricite": true,
"ascenseur": true,
"balcon": true,
"terrasse": true,
"parking": 123,
"cave": 123,
"jardin": true,
"velo": true,
"box": 123,
"piscine": true,
"sport": true,
"cinema": true,
"cheminee": true,
"tennis": true,
"barbecue": true,
"pingpong": true,
"interphone": true,
"coloc": true,
"colocOnly": true,
"start": "<string>",
"startRoom": true,
"embed": "<string>",
"isEmbed": true,
"embed2": "<string>",
"isEmbed2": true,
"public": "<string>",
"phone": "<string>",
"email": "<string>",
"dbOpen": 123,
"dbClose": 123,
"vitrage": "property.vitrage.simple",
"hauteur": 123,
"exposition": "property.exposition.nord",
"traversant": true,
"diagnostic": "property.diagnostic.need",
"dpe": 123,
"dpeAt": "<string>",
"ges": 123,
"lot": "<string>",
"immeubleName": "<string>",
"periclesId": "<string>",
"showPhone": true,
"pinel": true,
"digicode": "<string>",
"batiment": "<string>",
"escalier": "<string>",
"porte": "<string>",
"boiteAuxLettres": "<string>",
"poubelles": "<string>",
"disjoncteur": "<string>",
"compteurElec": "<string>",
"compteurElecId": "<string>",
"compteurGaz": "<string>",
"arriveeEau": "<string>",
"compteurEauChaude": "<string>",
"compteurEauFroide": "<string>",
"compteurThermique": "<string>",
"caveLocation": "<string>",
"parkingLocation": "<string>",
"boxLocation": "<string>",
"commentLocation": "<string>",
"bailDuration": "property.bailDuration.1to10month",
"bailRight": 123,
"terrainUsage": "property.terrainUsage.constructible",
"terrainViable": true,
"nbLots": 123,
"pmr": true,
"longueur": 123,
"largeur": 123,
"sousSol": true,
"surfaceSousSol": 123,
"vitrine": true,
"cuisine": true,
"encadrement": true,
"encadrementMinm": 123,
"encadrementMin": 123,
"encadrementMaxm": 123,
"encadrementMax": 123,
"nbLotsCoproperty": 123,
"courtProceeding": true,
"extraction": true,
"vueExcept": true,
"vueMer": true,
"surfaceTerrainBatiInclus": 123,
"surfaces": [
{
"m2": 123,
"surface": "surface.type.balcon"
}
]
}'
Copy
1
il faudra que l’equipe flatbay vous fournisse une clé d’api pour utiliser cette route.
afin de publier une annonce il faut renseigner
- start c’est “disponible a partir du”
- public c’est “Programmer la diffusion pour le”
ensuite
- offmarket, permet de mettre le bien en offmarket
- ubiflow, seloger, leboncoin, permet de diffuser le bien sur les plateformes correspondantes. (des lors qu’une plateforme est activée, leboncoin ou autre, il faut mettre ubiflow=1)
Query Parameters
Mot de passe pour l'accès sécurisé
Example:
"api_key_here"
Body
application/json
The body is of type object
.
Response
200
application/json
Détails de l'établissement récupérés avec succès
Identifiant du bien
Available options:
1
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
Example:
1
Copy
curl --request POST \
--url https://flatbay.fr/fr/api/property/create \
--header 'Content-Type: application/json' \
--data '{
"archive": true,
"offmarket": true,
"smartlead": true,
"addresscache": true,
"addressCacheRadius": 123,
"notifPublicationProp": true,
"address": "<string>",
"cp": "<string>",
"city": "<string>",
"country": "France",
"lng": "<string>",
"lat": "<string>",
"type": "property.type.maison",
"type2": "property.type2.mono",
"construction": "property.construction.1946",
"rentsellType": "property.rentsellType.rent",
"annonceTitle": "<string>",
"etage": 123,
"nbEtage": 123,
"nbPiece": 123,
"nbRoom": 123,
"nbDouche": 123,
"nbDetailDouche": 123,
"nbDetailBaignoire": 123,
"nbWc": 123,
"frais": 123,
"fraisLocationBailleur": 123,
"fraisLocationBailleurApplicable": "oui",
"fraisType": "property.fraisType.vendeur",
"fraisRoom": 123,
"surface": 123,
"eautype": "property.production.collectif",
"bailType": "property.bailType.collectif",
"chauffagetype": "property.production.collectif",
"description": "<string>",
"honorairesCalcul": "property.honorairesCalcul.percent",
"percentPrix": 123,
"percentRemise": 123,
"prix": 123,
"loyer": 123,
"depot": 123,
"edlHonoraire": 123,
"edlHonoraireBailleur": 123,
"charge": 123,
"energyBillMin": 123,
"energyBillMax": 123,
"foncier": 123,
"meuble": true,
"gardien": true,
"video": true,
"gli": true,
"plaque": true,
"four": true,
"microonde": true,
"frigo": true,
"jacuzzi": true,
"hammam": true,
"sauna": true,
"clim": true,
"travaux": true,
"ravalementDate": 123,
"refectionDate": 123,
"refectionCommuneDate": 123,
"travauxDesc": "<string>",
"laveLinge": true,
"secheLinge": true,
"laveVaisselle": true,
"cafetiere": true,
"tv": true,
"fibre": true,
"codeWifi": "<string>",
"grillePain": true,
"aspirateur": true,
"bouilloire": true,
"hotte": true,
"vaisselle": true,
"linge": true,
"internet": true,
"chauffage": true,
"eauchaude": true,
"eaufroide": true,
"entretien": true,
"entretienJardin": true,
"entretienChaudiere": true,
"ordures": true,
"menage": true,
"risque": true,
"electricite": true,
"ascenseur": true,
"balcon": true,
"terrasse": true,
"parking": 123,
"cave": 123,
"jardin": true,
"velo": true,
"box": 123,
"piscine": true,
"sport": true,
"cinema": true,
"cheminee": true,
"tennis": true,
"barbecue": true,
"pingpong": true,
"interphone": true,
"coloc": true,
"colocOnly": true,
"start": "<string>",
"startRoom": true,
"embed": "<string>",
"isEmbed": true,
"embed2": "<string>",
"isEmbed2": true,
"public": "<string>",
"phone": "<string>",
"email": "<string>",
"dbOpen": 123,
"dbClose": 123,
"vitrage": "property.vitrage.simple",
"hauteur": 123,
"exposition": "property.exposition.nord",
"traversant": true,
"diagnostic": "property.diagnostic.need",
"dpe": 123,
"dpeAt": "<string>",
"ges": 123,
"lot": "<string>",
"immeubleName": "<string>",
"periclesId": "<string>",
"showPhone": true,
"pinel": true,
"digicode": "<string>",
"batiment": "<string>",
"escalier": "<string>",
"porte": "<string>",
"boiteAuxLettres": "<string>",
"poubelles": "<string>",
"disjoncteur": "<string>",
"compteurElec": "<string>",
"compteurElecId": "<string>",
"compteurGaz": "<string>",
"arriveeEau": "<string>",
"compteurEauChaude": "<string>",
"compteurEauFroide": "<string>",
"compteurThermique": "<string>",
"caveLocation": "<string>",
"parkingLocation": "<string>",
"boxLocation": "<string>",
"commentLocation": "<string>",
"bailDuration": "property.bailDuration.1to10month",
"bailRight": 123,
"terrainUsage": "property.terrainUsage.constructible",
"terrainViable": true,
"nbLots": 123,
"pmr": true,
"longueur": 123,
"largeur": 123,
"sousSol": true,
"surfaceSousSol": 123,
"vitrine": true,
"cuisine": true,
"encadrement": true,
"encadrementMinm": 123,
"encadrementMin": 123,
"encadrementMaxm": 123,
"encadrementMax": 123,
"nbLotsCoproperty": 123,
"courtProceeding": true,
"extraction": true,
"vueExcept": true,
"vueMer": true,
"surfaceTerrainBatiInclus": 123,
"surfaces": [
{
"m2": 123,
"surface": "surface.type.balcon"
}
]
}'
Copy
1
Assistant
Responses are generated using AI and may contain mistakes.