#
Geräte steuern
Mit Ihrem KliServ-IoT API-Key können Sie Geräten steürn, die Sie auch in Dashboard steürn können.
Ihr API-Key muss die entsprechende Berechtigung aufweisen.
Der API-Endpoint ist: https://my-instance.kliserv-iot.com/api/v1/device/set
Die HTTP-Methode ist: POST
Ihren API-Key geben Sie im Header im Feld: Authorization:
an.
Im Body müssen Sie ein JSON-Objekt folgender Struktur senden:
{"serialNumber":"","value":{}}
Dabei ist "serialNumber"
die Seriennummer des zu steürnden Gerätes und "value"
, der Wert, auf welchen es gesetzt werden soll.
Seit v. 3.2.25
Das JSON-Objekt "value"
muss nun nicht mehr einen serielisierten JSON-String enthalten, sondern kann nun direkt das zu sendene JSON-Objekt enthalten!
Beispiel:
{"state": "off"}
Zu beachten ist, dass "value"
ein serielisierter JSON-String sein muss! Beispiel:
{\"state\": \"off\"}
Der Server gibt ein JSON objekt zurück, wobei der Parameter success
true/false
sein kann, je nachdem, ob der Request erfolgreich war.
Wenn der Request nicht erfolgreich war, gibt es außerdem noch die Parameter type
und msg
, wobei type = danger
ist und msg
eine Beschreibung des Fehlers enthält.