Aller au contenu
docs

Flux temps réel des mesures (SSE, text/event-stream)

GET /modules/{id}/stream
  • Scope readings:read
  • Clé API x-api-key
  • URL de base https://api.hub.akuasense.com/v1

Flux Server-Sent Events, ouvert tant que le client le garde. Quatre sortes de lignes :

  • event: ready — à l’ouverture : { "module_id": 256 } ;
  • event: measurement — la photo CALIBRÉE du module, toutes profondeurs, avec le même corps que GET /modules/{id}/measurements/latest. Envoyée juste après ready, puis chaque fois qu’une salve de mesures retombe ;
  • event: reading — une mesure vient d’arriver : module_id, module_sensor_id (le capteur, voir sensors[].id du module) et measured_at. Une trame arrive capteur par capteur : attendez-vous à une salve, suivie de la photo ;
  • : ping — un commentaire toutes les 25 secondes, qui garde la connexion ouverte.

Aucune reprise après coupure : à la reconnexion, la photo initiale redonne l’état courant.

Paramètres de chemin

  • id integer obligatoire

Réponse

200

Flux ouvert

Corps de réponse non documenté.

Erreurs

  • 400

    Paramètre invalide

    invalid_id
  • 401

    Non authentifié

  • 403

    Scope insuffisant ou ressource hors société