Lire et Piloter le contact auxiliaire

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 OU aux2}
• {deviceId} est à remplacer par le numéro unique d’association ou par le mot clef my.

Retour:

{
  "aux": "on",
  "enabled": true,
  "mode": "switch",
  "name": "Lumiere",
  "status": "on",
  "changed_at": null
}

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)

enabled indique si le contact auxiliaire est activé dans l’application ou non. Il peut prendre comme valeur true et false.

mode indique le mode de pilotage du contact auxiliaire. Il peut prendre comme valeur:

• switch: fonctionne comme un interrupteur
• regulredox: active le contact lorsque le niveau du RedOx est sous le seuil défini
• pulseX: active le contact pour X millisecondes (X peut prendre pour valeur 500, 1000, 1500, 2000, ou 2500)

name indique le nom du contact tel que défini dans l’application.

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 OU aux2}
• {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.