Pour découvrir l’API, nous recommandons d’utiliser le logiciel Postman et d’importer la configuration que nous mettons à disposition. Dans Postman, indiquez votre clé API dans les paramètres de la Collection > Variables > « cle_api ».

  • Méthode: GET
  • URL: https://api.oklyn.fr/public/v1/device/{deviceId}/data/{typeDeMesure}
  • {deviceId} est à remplacer par le numéro unique d’association ou par le mot clef my.
  • {typeDeMesure} est à remplacer par le nom d’une mesure parmi air, water (température de l’eau), ph, orp (redox).

Retour:

{
    "recorded": "2019-04-15T15:15:06+00:00",
    "value": 14.7,
    "status": null,
    "value_raw": null
}

recorded correspond à la date d’enregistrement des mesures.

value correspond à la valeur exploitable de la mesure. Pour les mesures de RedOx et de pH, value correspond à une moyenne pondérée sur les mesures des 18 dernières heures.

value_raw correspond à la valeur brute de la mesure, telle que transmise par la sonde.

status indique s’il y a une alerte en cours sur cette mesure. Il peut prendre comme valeur:

  • null: non applicable
  • normal: pas d’alerte en cours
  • warning: alerte en cours sur cette mesure (trop faible ou trop élevée)
  • danger: alerte importante en cours sur cette mesure (vraiment trop faible ou vraiment trop élevé)

Si votre question concerne un autre aspect, cliquez ici pour nous contacter.