FloPlan API Overview

FloPlan is a floor plan creation and integration system that integrates with MLS software. Agents use the FloPlan mobile app and phone camera to scan a home with a quick walk-through of a home, submit their scan, and receive a complete floor plan that they can link directly to their MLS listings. A developer can use the RESTful FloPlan API as outlined below to access any FloPlans created in the MLS. Built on the RESO Web API standard, FBS is committed to providing a standardized interface across any MLS you need to access FloPlan data within.

  1. Approval
  2. Server Endpoint
  3. Authentication
  4. Making Requests
  5. Response Description
  6. Replication Warning

1. Approval

Since the FloPlan API is standalone, existing access to a RETS feed, the Spark API, or a different RESO Web API feed will not also provide access to the FloPlan API. Such access would need to be requested separately by following the approvals process outlined on this page.

2. Server Endpoint

The FloPlan API endpoint is at:

https://api.floplan.io/Reso

3. Authentication

All developers will be issued non-expiring OAuth 2 access tokens that may be used to access the FloPlan API directly. All requests using such a token must be made using HTTPS.

Important!

Never provide your access_token to a web browser or other end-user agent. Instead, maintain a separate session and persist this data in a location accessible only by your application (e.g. do not store the access_token in a cookie). Contact api-support@floplan.io for further guidance.

To request data from the api you will need to provide two headers. The Authorization header and the Accept header. You will typically want an Accept header of application/json but, if you are accessing the metadata document of a RESO metadata document you will need to use application/xml. For the Authorization header you will use Bearer <your_access_token>.

Example /$metadata Retrieval Headers
Authorization: Bearer <your_access_token>
Accept: application/xml
Example /Media Retrieval Headers
Authorization: Bearer <your_access_token>
Accept: application/json

4. Making Requests

Make a GET request to one of the supported services to begin retrieving data from the FloPlan API. Note that the $filter parameter is required for all requests to the /Media endpoint. Your $filter must contain both the OriginatingSystemResourceRecordKey and OriginatingSystemResourceRecordSystemID fields. If either of these attributes are omitted an error code will be returned and your request will be unsuccessful. A full description of both attributes can be found in the supported services documentation. Example filters and requests can be found in the examples documentation.

https://api.floplan.io/Reso/Media?$filter=OriginatingSystemResourceRecordKey eq 'LISTINGKEY_HERE' and OriginatingSystemResourceRecordSystemID eq 'RESO_OUID_HERE'

Important!

Data replication is not allowed when using the FloPlan API. See the Replication Warning below for more information.

5. Response Description

All /Media endpoint responses will be in JSON format. All /$metadata responses will be in XML format. An example /Media and /$metadata payload can be found in the supported services documentation.

6. Replication

Data replication is strictly disallowed when using the FloPlan API. All data must be retrieved live from the API and cannot be stored locally. Stated another way, any time a user views a FloPlan floor plan on your website you must make a call to the FloPlan API to retrieve that data.