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 statut de la filtration
- Méthode: GET
- URL: https://api.oklyn.fr/public/v1/device/{deviceId}/pump
- {deviceId} est à remplacer par le numéro unique d’association ou par le mot clef my.
Retour:
{
"pump": "on"
"status": "on"
"changed_at": "2019-02-17 13:23:07"
}
pump peut prendre comme valeur:
- on: la commande de filtration est en marche forcée
- off: la commande de filtration est en arrêt forcé
- auto: la commande de filtration est en pilotage automatique
status donne l’état actuel de la filtration:
- on: la filtration est en marche
- off: la filtration est à l’arrêt
Piloter la commande de filtration
- Méthode: PUT
- URL: https://api.oklyn.fr/public/v1/device/{deviceId}/pump
- {deviceId} est à remplacer par le numéro unique d’association ou par le mot clef my.
Contenu:
{
"pump": "on"
}
pump peut prendre comme valeur « on », « off », et « auto ».
Retour: Identique à la lecture.
Si votre question concerne un autre aspect, cliquez ici pour nous contacter.