Situm JS SDK is a Javascript wrapper is formed by two parts:
- a library to consume and modify Situm data on our REST API
- and a library to integrate a visual Indoor Map Viewer on your site.
If you’re interested in using Situm JS SDK, please check the following resources:
Prerequisites #
- A Situm account and API credentials (API key or short‑lived token).
- At least one building with floorplans and (optionally) POIs/geofences in your Situm project.
- A web app capable of running ESM/UMD bundles.
Consume the REST API #
Situm JS SDK is a JavaScript wrapper that allows you to interact with the Situm REST APIs, making it easy to consume and modify Situm data in JavaScript-based applications. With this SDK, you can programmatically access and manage Situm’s cartography, enabling powerful indoor mapping solutions tailored to your needs.
This library is used internally by Situm and is also widely adopted by third-party developers to build a variety of cartography-based web applications. Some common use cases include:
- Updating cartography elements such as POIs and geofences directly from your frontend or backend systems.
- Building real-time positioning dashboards, combining cartographic data from the SDK with real-time location data retrieved via Situm’s REST APIs.
- Creating custom shop directories for shopping malls, with interactive floorplans, routing, and POI search features (although for this use case, we generally recommend using Situm’s Map Viewer).
- Developing complete cartography management apps to create, update, delete, and retrieve floorplans, POIs, geofences, and routes.
Integrate Visual Maps on your site #
The Viewer is a high‑level component of Situm JS SDK that embeds Situm Map Viewer into your web app and lets you control what’s shown (building/floor, POIs, routes…) and listen to events (ready, clicks, floor changes…). It’s the fastest path to integrate interactive indoor maps without wiring low‑level map code.
Typical use cases:
- Show a building’s floorplan(s) with pan/zoom controls.
- Toggle cartography layers (POIs, geofences, routes…).
- Inject real‑time positions on top of the map.
- Programmatically move camera (center/zoom/bounds) and react to user interactions.