Skip to main content
Version: 0.1.0

Eixam REST API

Public REST API for SDK integrations under /v1/sdk/*.

SOS and telemetry are primarily sent over MQTT (see the MQTT Integration guide). Publish SDKSOSIngestPayload to sos/alerts/<sdk_user_id>, publish SDKMQTTIngestPayload to tel/<sdk_user_id>/data, and subscribe to sos/events/<sdk_user_id>. POST /v1/sdk/sos and POST /v1/sdk/telemetry are optional HTTP fallbacks using the same JSON bodies as the matching MQTT publishes.

Only SDK integration routes are documented here. Platform-only app, operator, public portal, health, metrics, webhook, broker callback, and internal tooling APIs are intentionally excluded.

Core resources​

  • Identity — SDK profile (GET /v1/sdk/me). Use Authorization: Bearer <user_hash> where user_hash is the hex HMAC your backend issues for the SDK (signing is not a public HTTP API here).
  • Devices — paired hardware, firmware checks, and device configuration by country.
  • SOS Incidents — trigger, read, cancel, and resolve over HTTP or MQTT.
  • Emergency Contacts — CRUD and reorder.
  • Telemetry — append location/history over HTTP or MQTT.

Most SDK requests use headers X-App-ID, X-User-ID, and Authorization: Bearer <user_hash> (hex HMAC from your backend integration).

SDK Authorization​

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

Bearer format:

HMAC-SHA256 user hash