Situm Map Viewer offers a wide set of query parameters that can be used to adapt it to any needs. As an example, you may use an URL like:
https://map-viewer.situm.com/?lng=es&navigation_from=100593&navigation_to=92993&buildingid=7033&floorid=14468
The following table summarizes the most important query params:
| Query param | Description | Dynamic* / Static |
|---|---|---|
| Current user email | Static | |
| apikey | Current user API KEY. Use this endpoint or this Dashboard panel to get your api keys. | Static |
| buildingid | Indicates the selected building identifier. You may know a building ID by selecting a building on the Map Viewer and taking a look at the URL (it will change accordingly). You may also use this endpoint to get your buildings ids. | Dynamic |
| floorid | Indicates the selected floor identifier. You may know a floor ID selecting a floor on it on the Map Viewer and taking a look at the URL (it will change accordingly). You may also use this endpoint to get your floors ids. | Dynamic |
| poiid | Indicates the selected POI identifier. You may know a POI ID by clicking on it on the Map Viewer and taking a look at the URL (it will change accordingly). You may also use this endpoint to get your POIs ids. | Dynamic |
| category_id | When provided, the Map Viewer will initially load with the specified POI category selected in the Search panel. You can retrieve available category IDs using this endpoint. | Dynamic |
| navigation_to | Indicates the destiny POI identifier in a route. When you compute a route in the Map Viewer, navigation_to and navigation_from are properly set up with the POI IDs of the route, for your convenience. | Dynamic |
| navigation_from | Indicates the origin POI identifier in a route. When you compute a route in the Map Viewer, navigation_to and navigation_from are properly set up with the POI IDs of the route, for your convenience. | Dynamic |
| lng | Sets the language of the UI. Supported values: en (English), es (Spanish), fr (French), pt (Portuguese), it (Italian), tr (Turkish), ar (Arabic) and he (Hebrew). If not provided, the browser locale will be used if available (fallback language is English). | Static |
| rtl | Receives a boolean that when it’s true make texts and layout elements adapt to right to left languages. If not specified, it is false by default. | Static |
| lockCameraToBuilding | This boolean parameter controls the user’s exploration privilege within the canvas or world map. When set to true, it restricts navigation to the current building, limiting movement within its boundaries. Conversely, when set to false, users can freely explore the entire world map without restrictions. If not specified, it is true by default. | Static |
| fp | Indicates the POI identifier to be designated as a fixed POI. A fixed Point of Interest (POI) is a specific location identified by the provided identifier. Once designated as a fixed POI, this location maintains a consistent presence on the map, regardless of visibility settings or other configurations. It serves as a permanent and unchanging point for reference or focus. | Dynamic |
| deviceId | Allows you to provide an unique identifier of up to 16 characters that identifies an specific device. This is useful for retrieving usage analytics (e.g. most clicked POIs), allowing to distinguish the actions performed by different devices (e.g. counting how many devices have used a map). | Static |
| waitforauth | The Map Viewer remains on standby and does not request building data until authentication is provided. | Static |
| external_poi_id | When provided, the Map Viewer selects a POI on load using its external ID. Once resolved, this parameter is removed and replaced with the internal poiid parameter (Situm ID).You can interact with POIs using external IDs with these APIs. | Dynamic |
| external_category_id | When provided, the Map Viewer selects a POI category on load using its external ID. Once resolved, this parameter is removed from the URL. You can interact with POI categories using external IDs with these APIs. | Dynamic |
| external_navigation_from | When provided, the Map Viewer sets a POI (identified by its external ID) as the origin of a route on load. Once resolved, this parameter is replaced with navigation_from using Situm’s internal POI ID. | Dynamic |
| external_navigation_to | When provided, the Map Viewer sets a POI (identified by its external ID) as the destination of a route on load. Once resolved, this parameter is replaced with navigation_to using Situm’s internal POI ID. | Dynamic |
*While using the Map Viewer, some query params will be dynamically updated based on the actions performed by the user: this way, you may share the current state just by sharing the URL.
Email & apikey #
These two parameters are used together: they allow you to use your account and access to your organization’s available buildings.
https://map-viewer.situm.com/?email=<your_email_here>&apikey=<your_api_key_here>
buildingid & floorid #
These two parameters are used together: they trigger the display of the map in the specified floor that belongs to the specified building.
https://map-viewer.situm.com/?buildingid=7033&floorid=14467
poiid #
This parameter centers the view on the specified POI and shows the available information at the superior left corner. It usually goes with buildingid and floorid, which will autocomplete if missing.
https://map-viewer.situm.com/?poiid=47204
category_id #
Loads the Map Viewer with a specific POI category selected.
If the category exists, the Search panel will reflect the selected category and the category_id parameter will be removed from the URL.
https://maps.situm.com/?category_id=1234
navigation_to #
Situm Map Viewer allows you to ask for a route to different places: the destination POI is specified on the navigation_to query param. This parameter is always recommended to be used in combination with poiid.
https://map-viewer.situm.com/?buildingid=7033&floorid=14467&navigation_to=47204
navigation_from #
When the destination is selected, only the origin is missing to finish the route calculation. To do this we have navigation_from, which specifies the POI where you are expected to be and you are starting to walk towards the destination.
https://map-viewer.situm.com/?navigation_from=47196&buildingid=7033&floorid=14467
lng #
Use lng query param to force the User Interface to be on a specific locale language
https://map-viewer.situm.com/?lng=es&poiid=47196&navigation_from=47196&navigation_to=47204&buildingid=7033&floorid=14467
rtl #
When it is true, the map Viewer will mirror the elements of the interface to adapt the UI to right to left languages. It is commonly used with lng=ar or lng=he.
https://map-viewer.situm.com/?rtl=true&buildingid=7033&floorid=14467
fp #
This parameter designates the specified POI as a fixed POI, guaranteeing its prominence on the map and establishing it as the origin for all route computations. It overrides the custom field hide when it is set to on_map, ensuring the fixed POI is always displayed on the map.
https://map-viewer.situm.com/?fp=516721&lng=en&buildingid=7033&floorid=14467
deviceId #
This parameter allows you to provide an unique identifier of up to 16 characters that identifies an specific device (e.g. “12345678abcdefgh”). This is useful for retrieving usage analytics (e.g. most clicked POIs), allowing to distinguish the actions performed by different devices (e.g. counting how many devices have used a map).
https://maps.situm.com/?deviceId=12345678abcdefgh
waitforauth #
The Map Viewer remains on standby and does not request building data until authentication is provided. This prevents the default behavior of loading demo buildings.
Use the waitforauth query parameter with a boolean value, such as true.
This parameter is typically used together with the app.set_auth PostMessage action, which allows you to programmatically provide the API key or JWT to the Map Viewer.
If the credential is valid, the Map Viewer will load buildings normally and dismiss the loading screen.
If the credential is invalid, an authentication error screen will be displayed instead.
https://maps.situm.com/?waitforauth=true
external_poi_id #
Loads the Map Viewer with a POI selected using its external identifier.
Once the POI is found:
- The
external_poi_idparameter is removed from the URL. - The
poiidparameter is added using Situm’s internal POI ID to reflect the selected state.
https://maps.situm.com/?external_poi_id=EXTERNAL_ID
external_category_id #
Loads the Map Viewer with a POI category selected using its external identifier.
Once the category is found:
- The
external_category_idparameter is removed from the URL. - The Search panel opens with the corresponding category selected.
https://maps.situm.com/?external_category_id=EXTERNAL_CATEGORY_ID
external_navigation_from #
Loads the Map Viewer with a route origin defined by a POI external ID.
Once the POI is found:
- The
navigation_fromparameter is added using Situm’s internal POI ID. - The
external_navigation_fromparameter is removed.
https://maps.situm.com/?external_navigation_from=EXTERNAL_POI_ID
external_navigation_to #
Loads the Map Viewer with a route destination defined by a POI external ID.
Once the POI is found:
- The
navigation_toparameter is added using Situm’s internal POI ID. - The
external_navigation_toparameter is removed.
https://maps.situm.com/?external_navigation_to=EXTERNAL_POI_ID