Allgemeine Information zur API

[Admin]

Das Robonect H30x verfügt über eine API (offene Schnittstelle), um die Funktionen des Mähers auch eigenen Projekten zugänglich zu machen.

Allgemein
Das Robonect H30x Modul bietet die folgenden Schnittstellen zur Integration in eigene Anwendungen an.

• URL: http://192.168.2.1/xml?cmd=...
  Rückgabewert ist XML-Formatiert. Die Daten bedinden sich innerhalb eines <robonect>...</robonect> Tags.
• URL: http://192.168.2.1/json?cmd=...
  Rückgabewert ist JSON-Formatiert

Der Aufruf erfolgt bei allen Schnittstellen über einen Query String. Die Übergabe der Parameter erfolgt über das HTTP-GET-Verfahren. Pro Aufruf kann ein Kommando ausgeführt werden, welches über den cmd Parameter definiert wird.
Der unterstützte Befehlssatz ist bei beiden Schnittstellen identisch. Lediglich die Formatierung der Antwort unterscheiden sich.

Authentifizierung
Sofern Sie Benutzername und Passwort vergeben haben, müssen Sie sich beim nutzen dieser API ebenfalls authentifizieren. Dies kann auf zwei unterschiedliche Arten erfolgen:

• HTTP-Authentifizierung
• Als zusätzliche Parameter im Query String (z.B. http://192.168.2.1?user=...&pass=...&cmd=...)

Rückgabewert
Jede Anfrage wird mindestens mit dem successful Wert quittiert. Dieser boolesche Wert kann true oder false sein. Im Fehlerfall werden noch die zusätzlichen Werte error_code und error_message übertragen.
Die möglichen Fehlercodes sind hier beschrieben.