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 ».

Lire le contact auxiliaire

  • Méthode: GET
  • URL: https://api.oklyn.fr/public/v1/device/{deviceId}/aux
  • {deviceId} est à remplacer par le numéro unique d’association ou par le mot clef my.

Retour:

{
  "aux": "on"
  "status": "on"
  "changed_at": "2019-02-17 13:23:07"
}

aux donne l’état de la commande du contact. Il peut prendre comme valeur:

  • on: le contact est position allumé (fermé)
  • off: le contact est position éteint (ouvert)

status donne l’état actuel du contact. Il peut être différent de aux lorsque le coffret est en train d’exécuter l’action, ou que le coffret n’est pas connecté au WiFi.

Piloter le contact auxiliaire

  • Méthode: PUT
  • URL: https://api.oklyn.fr/public/v1/device/{deviceId}/aux
  • {deviceId} est à remplacer par le numéro unique d’association ou par le mot clef my.

Contenu:

{
  "aux": "on"
}

aux peut prendre comme valeur « on » et « off ».

Retour: Identique à la lecture.


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