Floorfy API

Ce contenu n’est pas encore disponible dans votre langue.

Sync listings between Floorfy and your CRM, marketplace or franchise. Create properties, upload 360° photos, order tours and floorplans, and get every result back in real time through webhooks.

Base URL: https://api.floorfy.com/api
Auth: ?tk= token in the query string
Body: JSON, wrapped in a data object
Result: status 0 ok · 1 error

Choose your token

Every call is signed with a token in the tk parameter. Which one you use depends on who you are.

Partner token Marketplaces, CRMs and franchises. Create one account per customer and manage all their listings and users. Uses tk_partner.

Agency token A single owner: a real estate agency, a fund or similar. Manage the listings of one account. Uses tk_agency.

Quickstart

From an empty account to a published virtual tour.

Get your token. Contact Floorfy Support to request a Partner Agreement and your tk_partner. As a partner, each agency you create returns its own tk_agency.
Create the property with your own identifier in id_origin. You’ll use it in every later call.

POST https://api.floorfy.com/api/property/add?tk={tk_agency}
Terminal
```
curl -X POST "https://api.floorfy.com/api/property/add?tk=$FLOORFY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "id_origin": "991121",
      "property_type": 2,
      "contract_type": 1,
      "location": { "city": "Barcelona" }
    }
  }'
```
Response
```
{ "status": 0, "message": "…", "id_floorfy": 115 }
```
Upload the 360° photos, one by one as base64 or as a list of URLs for Floorfy to download.

POST https://api.floorfy.com/api/multiple/scene/upload?tk={tk_agency}
Order the tour: a 360 or 3D assembly, a floorplan, or both.

POST https://api.floorfy.com/api/services/request?tk={tk_agency}
Get the result. Floorfy calls your webhook with property_published when the tour is ready, or you can poll the tour status.

Conventions

Requests are POST with a JSON body whose root element is data, except a few read endpoints that are GET.
Responses always include status (0 success, 1 error) and a human-readable message.
Omit optional fields you don’t have a value for. Sending an empty value is not the same as leaving it out.
Identifiers: id_origin is yours (the ID in your system); id_floorfy is ours. Store both.
Units are metric: areas in m².

Explore the reference

Partners Create and manage agencies, product limits and tokens.

Agencies Properties, panoramas, tours, users, folders, analytics and watermarks.

Webhooks Real-time events when a tour is published, a property changes and more.

Viewer SDK Control an embedded tour from your page and listen to its events.

Widgets Embed Floorfy sections, like panorama upload, inside your own CRM.