API Beschreibung

Tutorial: API Beschreibung

Durch die Einrichtung einer Programmschnittstelle ist der automatisierte Zugriff auf die Fernwartungsrouter über das Portal RSP mbCONNECT24 in Verbindung mit der mbDIALUP Software möglich. Dieses Tutorial verschafft einen Überblick über die Möglichkeiten und Schritte zum automatisierten Verbindungsaufbau.


1. Verbindungsaufbau über mbDIALUP

2. HTTPS Request Codes

3. Antworten aus Statusrequests

 


1. Verbindungsaufbau über mbDIALUP

Die mbDIALUP Software ist über Parameter steuerbar. Der automatische Verbindungsaufbau der mbDIALUP Software erfolgt durch die Eingabe eines Befehls.

Beispiel:
Kontoname: mbc-training
Benutzername: admin
Passwort für diesen Benutzer: 12hef

Es können folgende Varianten für den automatischen Verbindungsaufbau gewählt werden:

1. mbdialup.exe s c u: admin@mbc-training p:12hef

  Es wird der zuletzt verwendete Server zum verbindungsaufbau genutzt. Die Benutzerdaten aus den Aufrufparametern werden für den Verbindungsaufbau hergezogen.

2. mbdialup.exe s c l:rsp.mbconnect24.net

Es wird der Servereintrag „rsp.mbconnect24.net“ benutzt, inkl. der hinterlegten Benutzerdaten.

3. mbdialup.exe s c u: admin@mbc-training p:12hef l:rsp.mbconnect24.net

Es wird der Servereintrag „rsp.mbconnect24.net“ benutzt, die Benutzerdaten werden jedoch aus den Aufrufparametern benutzt.

Parameter

s    Silent            Verbindung wird ohne Dialog gestartet

c    Connect       Verbinden

   Benutzer      Benutzer inklusive Kontoname in der Form u:admin@test

p    Passwort     Passwort für den mit u angegeben Benutzer in der Form p:12hef

l     Server          Server aus der Serverliste


Hinweis: Es darf keine Instanz der mbDIALUP geöffnet sein da der Befehl sonst nicht funktioniert.

Um den Befehl zum automatischen Öffnen der mbDIALUP sowie zur automatischen Anmeldung eines Benutzers auszuführen, muss hierzu „CMD“ geöffnet werden.
Anschließend muss via „CMD“ in das Verzeichnis gewechselt werden, in der mbDIALUP installiert ist.
Befindet man sich im Installationsverzeichnis, in diesem Beispiel C:\Program Files (x86)\MB Connect Line GmbH\mbDIALUP, kann der Befehl ausgeführt werden.

Befehl: mbdialup.exe s c u:admin@mbc-training p:12hef l:rsp.mbconnect24.net

Ist der eingegebene Befehl korrekt, öffnet sich mbDIALUP und der eingegebene Benutzer wird angemeldet:

 

2. HTTPS Request Code

Die Verbindung zur Portaloberfläche und innerhalb dieser kann durch HTTPS Request Codes gesteuert werden. Dazu können die nachfolgenden Befehle genutzt werden. Die rot markierten Stellen sind durch die eigenen Angaben zu ersetzen.

Verbindungsstatus des Benutzers prüfen:
https://10.0.1.1/index.php?option=com_mb24api&format=raw&task=status&user=Benutzername@Kontoname

Verbindungsstatus des Gerätes prüfen:
https://10.0.1.1/index.php?option=com_mb24api&format=raw&task=status&device=Gerätename@Kontoname

Verbindung zu einem Gerät herstellen:
https://10.0.1.1/index.php?option=com_mb24api&format=raw&task=connect&user=Benutzername@Kontoname&device=Gerätename@Kontoname

Verbindung zu einem Gerät trennen:
https://10.0.1.1/index.php?option=com_mb24api&format=raw&task=disconnect&user=Benutzername@Kontoname&device=Gerätename@Kontoname

Troubleshooting: Falls die Route zum Gerät nicht automatisch erstellt wird, muss der Befehl zum Herstellen der Verbindung zu einem Gerät erneut eingegeben oder die Route manuell auf dem PC erstellt werden.

Man sieht die Route zum Gerät in der Fußzeile von mbDIALUP:

 

3. Antworten aus Statusrequests

Jeder Statusrequest gibt eine Antwort in folgender Art aus:

Der Befehlsstatus kann 0 oder 1 sein.

0 = Der Befehl konnte nicht ausgeführt werden
1 = Der Befehl wurde erfolgreich ausgeführt

Der Befehlsrückgabewert gibt einen spezifischen Wert aus. Dieser Wert ist abhängig vom Wert des Befehlsstatus.

Wenn Befehlsstatus = 0 (Befehl konnte nicht ausgeführt werden), können folgende Befehlsrückgabewerte ausgegeben werden:

1 = Befehl unbekannt (UNKNOWN_TASK)
2 = Kein solcher Benutzer vorhanden (NO_USER)
3 = Benutzer nicht online (USER_NOT_ONLINE)
4 = Benutzer ist bereits verbunden (USER_ALREADY_CONNECTED)
5 = Gerät existiert nicht (NO_DEVICE)
6 = Gerät nicht online (DEVICE_NOT_ONLINE)
7 = Gerät ist bereits verbunden (DEVICE_ALREADY_CONNECTED)
8 = Benutzer und Gerät müssen sich im selben Konto befinden (USER_AND_DEVICE_MUST_BE_IN_SAME_ACCOUNT)
9 = Kein Benutzer oder Gerät gefunden (NO_USER_OR_DEVICE_FOUND)

Wenn Befehlsstatus = 1 (Befehl konnte ausgeführt werden), können folgende Befehlsrückgabewerte ausgegeben werden:

1 = offline
2 = online
3 = connected

 

Revision: V1.1