Plans Static API

The Plans Static API lets you embed an image of a floorplan or siteplan in your web page without requiring JavaScript or any dynamic page loading. Images are created using standard URL parameters that allow you to customise the appearance of the plan.

Example

The following example shows the URL of a Plans Static API image, which is displayed below.

https://api.locatrix.com/plans-static/v1/image?partner=cadr0g675rbk0fv03fm5fewz7
&floor=flr_95kpvk552x7ue5xvb4f290a4q
&format=png&w=640&h=360
&expiry=2145916800
&apikey=YOUR_API_KEY
&sas=YOUR_GENERATED_SAS_TOKEN

Example floorplan image from the Plans Static API

Authentication

You authenticate requests with the Plans Static API using your API key and SAS tokens generated from your API secret. The use of SAS tokens ensures that users are only allowed to access the resources that you want them to access.

Capabilities

The Plans Static API has two capabilities:

  1. Generate images of floorplans/siteplans
  2. Get georeferencing information for those images

By providing georeferencing information, the Plans Static API empowers you to use plan imagery in many different use cases, such as overlaying plans onto your own maps.