Choose an Integration
Choose by runtime responsibility: mobile device features belong in the Flutter SDK, user-scoped SDK integrations use the REST API, and app-wide server workflows use the Backend API.
Comparison
| Feature | Flutter SDK | REST API | Backend API |
|---|---|---|---|
| Platform | Flutter on Android and iOS | Any client using an SDK user's identity | Server-to-server backend or service |
| BLE device support | Pairing, reconnect, typed device state, and commands | Not available | Not available |
| SOS | Full SDK-owned lifecycle and capability selection | User-scoped HTTP fallback or contracted MQTT | Not part of this API |
| Realtime events | Managed MQTT lifecycle and typed streams | Direct MQTT integration where contracted | Not part of this API |
| Protection Mode | Android-first, capability-aware runtime | Not available | Not available |
| OTA firmware updates | Availability, blockers, transfer, reconnect, and verification | SDK integration endpoints | Not available |
| LoRa radio region | Country detection, confirmation, apply, reboot, and verification | SDK integration endpoints | Not available |
| Users and devices | SDK profile and paired-device state | Current SDK user's data | App-wide user, device, and linking management |
| Telemetry | Managed device and location flows | Current SDK user's HTTP fallback | App-wide ingestion, history, search, and batch writes |
| Authentication | SDK manages signed user identity | Your integration supplies SDK user headers | App-scoped Bearer credential with explicit scopes |
- Flutter SDK
- REST API
- Backend API
Choose the Flutter SDK when the mobile app needs any device or safety runtime feature:
- Direct BLE pairing with Eixam hardware
- SOS, PRE-SOS, DMP, or Protection Mode
- Managed realtime telemetry and device state
- OTA firmware updates or regional LoRa configuration
Start here: Flutter SDK Overview
Choose the REST API when you are:
- Integrating from a backend service or non-Flutter platform
- Managing authenticated user, device, SOS, contact, or telemetry data
- Implementing an agreed direct MQTT integration
The REST API does not replace the Flutter SDK for BLE, OTA transfer, device reboot/verification, or Protection Mode.
Start here: REST API Reference
Choose the Backend API when your server needs to:
- Manage users and devices across an Eixam app
- Link or unlink devices without a mobile runtime
- Ingest, search, or batch-process app-wide telemetry
The Backend API uses a credential created in Portal under Credentials and usage. It does not replace the Flutter SDK for BLE, SOS, OTA, device reboot/verification, or Protection Mode.
Start here: Backend API Reference