Locatrix API Documentation

Check out some examples in our git repository.

ESAPI

The ESAPI is the entry point for using the Locatrix APIs. Use the ESAPI to navigate the client/campus/building/floor hierarchy, fetch data about plans, and retrieve plan codes and viewer tokens for use with the Plans APIs.

Plans Static API

Add static images of floorplans or siteplans to your web page without requiring JavaScript or any dynamic page loading. Image URL parameters allow you to customise the appearance of the plan.

Plans Embed API

Add plan viewers for floorplans and siteplans to your web page without directly using the Plans JavaScript SDK. Iframe URL parameters allow you to customise the appearance of the plan and configure SDK features.

Plans JavaScript SDK

Add customisable plan viewers to your web page using JavaScript. The SDK manages the loading of plans and allows you to query them for information (such as what icons are present) so that you can create your own tailored experiences.