Situm SDK JS

A JavaScript library to interact with the Situm REST APIs to build your own applications with the power of SITUM.

Getting Started

The SITUM SDK JS is Javascript library to create web applications using the REST API from Situm. This will allow you to fetch geospacial information and create your own js-based applications. We aim to make it easy to use for you and to keep your focus on creating your business logic over our services.

The best way to get started is to navigate through the Situm SDK JS documentation site:

• Guide will give you a good overview of the library.
• API Reference will help you use a particular class or method.
• Examples will demo some specific features.
• Support might answer some of your questions.

This library is organized into distinct domains, each targeting a specific aspect of indoor mapping and positioning. This separation helps you focus on relevant functionality for your application. The main domains are:

Name	Explanation	Example
Cartography	Handles map data, such as buildings, floors, and points of interest.	sdk.cartography.getBuildings()
Realtime	Manages real-time location tracking and positioning.	sdk.realtime.getPositions()
Viewer	Provides tools to render interactive maps and visualizations in your web application.	sdk.viewer.create({})
User	Manages user accounts and authentication.	sdk.user.createUser()
Reports	Accesses analytics and reporting features, such as visit or usage reports.	sdk.reports.getTrajectory()
Images	Handles image retrieval and management, such as map or POI images.	sdk.images.uploadImage()

Each domain exposes its own set of classes and methods, making it easier to work with geospacial data, live positioning, or map rendering independently.

Examples

Fetching all the buildings from the api

const sdk = new Situm({auth: {apiKey: YOUR_API_KEY});
const buildings = sdk.cartography.getBuildings();
Copy

Fetching realtime positions from the api

const sdk = new Situm({auth: {apiKey: YOUR_API_KEY});
const positions = sdk.realtime.getPositions();
Copy

Render an interactive viewer on a div:

<div id="viewer1"></div>
Copy

const sdk = new Situm({auth: {apiKey: YOUR_API_KEY});
const viewer = sdk.viewer.create({
  domElement: document.querySelector("#viewer1");
});

viewer.on(ViewerEventType.MAP_IS_READY, () =>
  console.log("viewer1: map is ready")
);
Copy

Check the examples folder on the repository to see more examples.

Documentation

General documentation

You can read the general documentation that is published at https://situm.com/docs/websdk-javascript-sdk-quickstart-guide/.

Guides

The folder docs/guides contains general information about the Situm SDK JS library.

• Quick start: get started quickly following this tutorial.
• Upgrade considerations: if you have experience with previous versions of Situm SDK JS, this is the place to learn the differences between the former library and the newest one.
• Glossary: terms that appear throughout the documentation.

API Reference

You can find a published api reference at https://developers.situm.com/sdk_documentation/sdk-js/index.html

Or run yarn doc at the repository to build the API reference documentation from jsdoc annotations.

Once the task is done, you can visit docs/public/index.html to check the reference

Examples

In the folder examples/ you can find several folders with example for every feature of Situm SDK JS.

Run them with:

npx tsx examples/filename.ts
Copy

Development

See DEVELOPMENT.md for more information.

Versioning

We use SemVer for versioning.

Please refer to CHANGELOG.md for a list of notables changes for each version of the library.

You can also see the tags on this repository.

Submitting Contributions

You will need to sign a Contributor License Agreement (CLA) before making a submission. Learn more here.

License

This project is licensed under the MIT - see the LICENSE file for details.