Home

Professional account holders can access their data using the Floorplanner Application
Programming Interface (API). This can be used to integrate Floorplanner in your own website,
or automate repetitive tasks. The Floorplanner API consists of two parts: the Javascript API
and the REST API. To communicate between these APIs, an XML format is used to encode
projects and designs.

Javascript API

The Javascript API can be used to include the Floorplanner application within an HTML page.
Its primary function is to make it easy to embed the application within an given DIV-element
of the HTML page and iron out the differences between browsers. It contains functions to
access information about the current project, function to get and set the state of the
application and function to control it. Moreover, it provides hooks to respond to events that
occur while the application is running.

This is a client-side API, which means that the code will run within the browser of the users.
The Javascript API has been tested with Internet Explorer 6 and 7, Firefox 2 and 3 and Safari 3.
Because Floorplanner is a Flash application, users must have the Flash plugin (version 9 or higher)
installed on their system.

• JavascriptTutorial: Tutorial to get started quickly
• JavascriptOptions: Reference of all the options that can be passed to Floorplanner
• JavascriptEvents: Reference of all the Floorplanner events that can be handled with Javascript
• JavascriptFunctions: Function reference of the Floorplanner object

REST API

The REST API can be used to access your account(s) and to manage your projects and designs. It can
also be used to retrieve tokens, that must be provided to the Floorplanner application to give it
write access to our server. This is required to be able to save designs on our servers.

This is a server-side API, which means that it can be accessed from server-side scripting languages
like PHP and Ruby. However, it is possible to access this API using AJAX as well. To be able to use
this API, a API key is needed. You can generate an API key yourself by going to the “My account”
page and press the “API key” button in the sidebar.

• Getting started
• Reference
• PHP classes and examples
• Ruby on Rails classes and examples
• ASP.NET classes and examples

Floorplanner Markup Language (FML)

Floorplanner Markup Language (FML) enables you to communicate complete plans including floors and designs. You can create plans on the fly by sending it to our API, or you can store plans locally outside our database.

FML is an XML format designed by us to capture everything of a Floorplanner design into a simple structure. This design structure can be extended with information about floors and projects.

• DesignFML Documentation on how a design is represented in FML
• ProjectFML Shows how to create a complete plan including floors and designs
• AssetIds Gives an overview of all the assets including its id’s available for the designs

Support

We try to offer a complete, well documented API for our customers. If you have any questions, remarks or suggestions, please contact us or visit our forums.