API Overview
Primary Device APIHTTP
Web AuthSession
PayloadJSON
Integration ModelRESTMQTT-ready architecture
Current API surface
The current testing build focuses on hardware-to-platform telemetry, heartbeat, dashboard data, commands, OTA and webhook/integration workflows. Mobile application UI is intentionally outside the current product phase.
Core endpoints
| Method | Endpoint | Auth | Purpose |
|---|---|---|---|
| POST | /api/telemetry/ingest | Device key | Ingest one or more telemetry metrics |
| POST | /api/heartbeat | Device key | Update genuine device activity |
| GET | /api/device-commands | Device key | Fetch queued device commands |
| POST | /api/device-command | Session | Queue a control command from the web app |
| GET | /api/ota-device | Device key | Check device-specific firmware deployment |
| GET | /api/live-metrics | Session | Refresh live dashboard metrics |
| GET | /api/reports-data | Session | Load historical report series |
Developer quick start
1. Create a device. 2. Copy or view its device API key. 3. Add the required sensors/datastreams. 4. POST telemetry using that same hardware key. 5. Keep heartbeat or valid telemetry flowing so online status remains truthful. 6. Build dashboards and reports from the incoming datastreams.