REST API Overview
:::info Coming soon The Eixam REST API documentation is currently in progress. The endpoints and authentication contracts are described below as a reference for backend integrations while the full documentation is being prepared. :::
The Eixam REST API lets you integrate with the platform directly via HTTP and MQTT — no client SDK required. It is suited for backend services, web applications, or any platform where a native SDK is not available.
Authentication
All requests are authenticated with a signed session generated by your backend.
HTTP headers
X-App-ID: <appId>
X-User-ID: <externalUserId>
Authorization: Bearer <userHash>
MQTT credentials
username: sdk:<appId>:<externalUserId>
password: <userHash>
userHash is an HMAC-SHA256 signature of externalUserId using your app secret. See Identity Signing for implementation examples.
Key endpoints
| Endpoint | Method | Description |
|---|---|---|
/v1/sdk/me | GET | Enrich the signed session with canonical backend identity |
/v1/sdk/sos | GET | Retrieve active SOS incident |
/v1/sdk/sos/cancel | POST | Cancel an active SOS |
/v1/sdk/devices | GET | List registered devices for the signed user |
Full documentation
Full REST API documentation including request/response schemas, error codes, and MQTT topic references will be available here. In the meantime, refer to the Backend HTTP & MQTT Reference in the Flutter SDK section for the current endpoint and auth contracts.