@pointr-tech/web-sdk
v10.14.0
Published
Pointr Web SDK
Readme
Pointr Web SDK
Pointr Web SDK provides interactive indoor maps and static wayfinding for web apps and kiosks.
- Docs: Web SDK References
- Playground: Web Playground (Code Editor)
- Sample projects: Download a Sample Project
Install
npm install @pointr-tech/web-sdkYou can integrate the SDK either from npm (bundled in your app) or directly via CDN.
Quick Start (npm + bundler)
import PointrWebSDK from '@pointr-tech/web-sdk'
import "@pointr-tech/web-sdk/css";
const options = new PointrWebSDK.Options({
container: "pointr-map",
baseUrl: "BASE_URL",
clientIdentifier: "CLIENT_IDENTIFIER",
licenseKey: "LICENSE_KEY",
});
const pointrWeb = new PointrWebSDK.MapWidget(options);
pointrWeb.start();<div id="pointr-map"></div>Quick Start (CDN)
Add SDK assets to your HTML:
<head>
<link href="https://pointr-websdk.azureedge.net/${version}/css/pointr.css" rel="stylesheet" />
<script src="https://pointr-websdk.azureedge.net/${version}/pointrwebsdk.js"></script>
</head>Initialize and start the map:
<script>
document.addEventListener("DOMContentLoaded", function () {
const options = new PointrWebSDK.Options({
container: "pointr-map",
baseUrl: "BASE_URL",
clientIdentifier: "CLIENT_IDENTIFIER",
licenseKey: "LICENSE_KEY",
siteInternalIdentifier: "SITE_INTERNAL_IDENTIFIER", // optional
});
const pointrWeb = new PointrWebSDK.MapWidget(options);
pointrWeb.start();
});
</script>
<div id="pointr-map"></div>Authentication Options
Option 1: Client credentials
Set these required options:
baseUrlclientIdentifierlicenseKey
Option 2: Pointr Cloud Token
You can initialize with pointrCloudToken instead of client credentials:
document.addEventListener("DOMContentLoaded", function () {
const options = new PointrWebSDK.Options({
container: "pointr-map",
pointrCloudToken: "POINTR_CLOUD_TOKEN",
siteInternalIdentifier: "SITE_INTERNAL_IDENTIFIER", // optional
});
const pointrWeb = new PointrWebSDK.MapWidget(options);
pointrWeb.start();
});When using token-based initialization, you are responsible for token refresh:
pointrWeb.setPointrCloudToken(access_token);See Pointr Cloud API Reference for token retrieval.
Required Options
| Option | Type | Description |
| -------------------------- | -------- | ----------------------------------------------- |
| baseUrl | string | URL of your Pointr Cloud instance. |
| clientIdentifier | string | Client internal identifier provided by Pointr. |
| licenseKey | string | Client secret / license key provided by Pointr. |
For full option details, see Web SDK References.
Common Use Cases
Important Notes
- Due to browser limitations (especially Bluetooth/background constraints), real-time positioning is supported on Mobile SDK, not Web SDK.
- SDK and map configuration can be updated from Pointr Cloud Dashboard without app redeploy; changes are typically visible within ~15 minutes.
