Skip to main content

API Integration

Slamcore Aware exposes two integration paths. If your system supports it, VDA5050 is the recommended path.

  • ⭐ VDA5050 (Recommended) — The simplest way to get started. Connect Slamcore Aware to your fleet manager over MQTT and VDA5050 protocol with minimal setup.

  • 🔌 REST + WebSocket — For systems that cannot use MQTT. Interact with Slamcore Aware over HTTP or HTTPS and receive real-time device events via WebSocket.

Before You Integrate​

Regardless of which path you choose, read this section first.

Checking Localisation State Before Using Pose Data​

Slamcore Aware outputs position data as soon as positioning starts, but the pose is only reliable once the device has successfully localised on a map.

important

Always check the positionInitialized or localised flag before consuming position output in your application. When this flag is false, the device has not yet relocalised and the reported pose should not be used.

  • REST API: localised is present in the pose response.
  • WebSocket: localised is included in the FullPose stream messages.
  • VDA5050: positionInitialized appears in the state and visualization topic messages.

VDA5050 Integration Requirements​

To use VDA5050:

  1. An MQTT broker is required on your network (for example, Mosquitto). The broker can run on a local machine or be cloud-hosted.
  2. Configure the broker connection in Slamcore Aware under settings_icon Settings > Integrations > VDA5050.
  3. Slamcore Aware publishes to the connection, state, and visualization topics. A custom perception topic is available when enabled.
tip

See also

See VDA5050 for the full topic reference and message examples.

REST + WebSocket Integration Requirements​

Authentication​

All REST and WebSocket requests require authentication. Before making any API call, generate an API key for the target device from settings_icon Settings > Integrations. See API Authentication for step-by-step instructions.

note

Each API key is device-specific. If you are integrating with multiple Slamcore Aware devices, generate a separate key for each one.

Getting Started​

To use the REST and WebSocket APIs:

  1. Generate an API key (see API Authentication).
  2. Use https://<DEVICE_HOST> where possible when making REST API calls. HTTPS is optional for now, and http://<DEVICE_HOST> remains supported.
  3. Obtain a Bearer token by calling POST /v0/login/api_key with the API key.
  4. For WebSocket access, exchange the Bearer token for a WS token via GET /v0/ws_token, then connect to wss://<DEVICE_HOST>/v0/slam/ws/<WS_TOKEN> when using HTTPS, or ws://<DEVICE_HOST>/v0/slam/ws/<WS_TOKEN> when using HTTP.
  5. All messages sent and received over the WebSocket must be JSON-encoded.
tip

See also

The REST API (v0) and AsyncAPI Spec (v0) pages contain the full specifications including all available endpoints and message types.

API Reference​