Introduction

Most companies that want to integrate Floorplanner into their website or mobile app, want to embed the editor and be able to export 2D & 3D floorplan images. This page walks you through the steps necessary to make that happen. Please note that this guide is limited to the new HTML5 editor and the new API v2.

Table of contents

Floorplanner Partner account

First of all, you need a Floorplanner Partner account to be able to use the Floorplanner API. A Floorplanner account costs € 99,- ($ 149,-) a month and comes with 100 premium projects. Premium means that you can export 2D & 3D images at a high resolution (up to 4K) and optionally with a custom logo and disclaimer.

Sandbox vs production

We have a testing environment called ‘sandbox’ and a production environment. For both environments you need to have a different API key. You can request your API keys by sending an email to Floorplanner Support. Make sure you also request your user IDs as you need a user ID at a later stage. The Floorplanner API uses HTTP Basic Authentication and this section explains how you should use your API key in this authentication scheme.

The sandbox API and the production API run on different domains, make sure you use the right one: Sandbox URLhttps://site_sandbox.floorplanner.com/api/v2/

Production URLhttps://floorplanner.com/api/v2/

Create new project

Before you can embed the editor you first have to create a new project. A project represents a household; a free standing house with multiple levels or a single level apartment. This section explains how to create a new project using the API. Please remember the project ID that is returned in the result, because you need it later when embedding the editor.

Request token

Projects are private by default, meaning that you can’t access them unless you are logged in and are the owner. Since our API is stateless we use tokens to give the editor a way to authentication its requests. This section describes how you can request a token. Please remember the token ID that is returned in the result, because you need it later when embedding the editor.

Embed the editor

Once you have a project ID and a token you can embed the editor. This page describes in detail how to do that.

If you want to customize the editor to your needs, have a look at the Settings section. It’s possible for example to set the wall top colors in 2D & 3D, which furniture items (collections) to load or which room type sets to use.

Export 2D & 3D floorplan images

You can export all the floorplans of a project as 2D or 3D images via this API method. Please note that when you export a project, only the first design (variant) of the floor levels are exported. It’s also possible to export a single floorplan (design / variant) as a 2D or 3D image via this API method.

Export FML

Most companies won’t need this, but some want to be able to export their projects as FML data. This can be done simply adding .fml to the URL, for example:

URL/projects/:project_id.fml