Device API Starter Kit

Practical notes for integrating a physical prototype

This kit describes the authenticated Device API only. Operator provisioning happens in the technical console and is not part of the device-facing contract.

Base URL

https://api-dev.zorgassistent.eu

All device operations use /v1/device/* and require device credentials. The patient is resolved server-side from the active assignment. Do not send a patient id.

  • A newly provisioned device starts as PENDING and cannot use this API until its lifecycle is ACTIVE.
  • Schedules are versioned. Fetch the current schedule, store it locally, then acknowledge the accepted scheduleId and version.
  • Events need a unique eventId of at least 8 characters. Retrying the same event is idempotent.
  • Temporary network loss must not stop an already valid local schedule. Buffer events and send them after reconnect.