WebSocket

wss://your-api-host/realtime?api_key=YOUR_API_KEY

{
  "type": "connected",
  "connectionId": "conn-1702812600000-1"
}

{
  "type": "subscribe",
  "hardwareIds": ["ABC123", "DEF456"]
}

{
  "type": "subscribed",
  "hardwareIds": ["ABC123", "DEF456"]
}

{
  "type": "unsubscribe",
  "hardwareIds": ["ABC123"]
}

{
  "type": "unsubscribed",
  "hardwareIds": ["ABC123"]
}

{
  "type": "device_data",
  "hardwareId": "ABC123",
  "payload": {
    "lat": 37.7749,
    "long": -122.4194,
    "speed": 15.5,
    "battery_voltage": 12.4,
    "lock_status": 0
  },
  "timestamp": "2025-12-17T10:30:00.000Z"
}

{
  "type": "device_status",
  "hardwareId": "ABC123",
  "payload": {
    "is_online": false
  },
  "timestamp": "2025-12-17T10:30:00.000Z"
}

{
  "type": "device_locked",
  "hardwareId": "ABC123",
  "eventId": "evt_125",
  "source": "key",
  "timestamp": "2025-12-17T10:30:00.000Z"
}

{
  "type": "error",
  "message": "hardwareIds must be an array"
}

const ws = new WebSocket("wss://your-api-host/realtime?api_key=YOUR_API_KEY");

ws.onopen = () => {
  ws.send(JSON.stringify({ type: "subscribe", hardwareIds: ["ABC123"] }));
};

ws.onmessage = (event) => {
  const msg = JSON.parse(event.data);
  switch (msg.type) {
    case "device_data":
      console.log("Telemetry:", msg.hardwareId, msg.payload);
      break;
    case "device_status":
      console.log("Status:", msg.hardwareId, msg.payload.is_online);
      break;
    case "device_unlocked":
      console.log("Unlocked:", msg.hardwareId, msg.source);
      break;
    case "device_locked":
      console.log("Locked:", msg.hardwareId, msg.source);
      break;
  }
};