Remote Interface

Gesperrt
boeserwolf
Core Developer
Beiträge: 677
Registriert: Di 3. Jun 2014, 14:33
Wohnort: München
Hat sich bedankt: 11 Mal
Danksagung erhalten: 53 Mal

Remote Interface

Beitrag von boeserwolf » Mo 2. Jul 2018, 19:23

An english Version is in work! Come back soon for more :-)
<---------------------------------------------------------------------->
Das Remote Interface gibt es schon ziemlich lange im Bot: Vorgesehen für die Anbindung per App wurde sie aufgrund von Zeitmangel bisher aber nie genutzt. Es gab in den letzten Jahren mehrere Anläufe die App zu bauen(und auch mehrere Neu-Implementierungen der Schnittstelle dafür) bis Unknown jetzt zu uns stieß. Mit der ersten Version seiner Web-Oberfläche hat das Interface nun eine gewisse Reife damit wir es euch zur Verfügung stellen können.

Voraussetzungen:
Unter Windows kann es nötig sein den Bot einmalig als Administrator zu starten damit der Port geöffnet werden kann.
Wir übernehmen für Schäden keine Haftung die durch Sicherheitslücken im Bot entstehen!

Erste Schritte:
In den globalen Einstellungen muss die Option "Erweiterte Ansicht" aktiviert werden damit die Einstellungen für den Fernzugriff sichtbar werden.

Folgende Einstellungen sind Pflicht:
- Aktiviere Remotezugriff => aktiviert die Remote Schnittstelle
- Port => Netwerkport auf dem die Schnittstelle bereitgestellt wird
- IP => IP auf der die Schnittstelle bereitgestellt wird. Für lokale tests wird localhost(127.0.0.1) empfohlen
- Administrator User => Benutzername des Administrators. Dieser hat Zugriff auf alle Accounts sowie auf globale Logs und Einstellungen
- Administrator Passwort => Passwort des Administrators

Optionale Einstellungen:
- Entwicklermodus => Verbessert die Ausgabe der Schnittstelle durch formatiertes JSON sowie detaillierte Fehlermeldungen. Nur für Tests aktivieren!
- zusätzliche Benutzer: Es ist möglich zusätzliche User anzulegen. Diese können Zugriff auf alle oder auch nur einige Accounts haben. Sie haben keinen Zugriff auf globale Einstellungen/Logs!

Nach einem Klick auf "Einstellungen testen" wird die Schnittstelle gestartet. Wenn alles gut geht steht nun bei Fernzugriff in grün: "läuft".

Der erste Aufruf:
Die Schnittstelle basiert auf HTTP und JSON. Die Schnittstelle an sich ist selbstdokumentierend(wenn auch nicht immer selbsterklärend) da man über einen Request Informationen über alle Daten und Optionen erhalten kann.
- Mit einem OPTIONS Aufruf bekommt man Informationen über die Schnittstelle.
- Mit einem GET erhält man Daten vom Bot.
- Mit einem DELETE kann man Objekte löschen.
- Mit einem POST kann man Daten ändern.

Für erste Tests eignet sich am Besten cURL. Nachfolgend beschrieben sind einige Kommandos:
Beschreibung welche Optionen die Schnittstelle bereit stellt:
curl -u user:passwort -X OPTIONS http://localhost:8443/
Beschreibung welche Optionen das Bot-Objekt bereit stellt:
curl -u user:passwort -X OPTIONS http://localhost:8443/bot

anzeige aller aktuellen Daten:
curl -u user:passwort -X GET http://localhost:8443/
anzeige der Kurzinfo:
curl -u user:passwort -X GET http://localhost:8443/?head=1

Anzeige von Einstellungen:
curl -u user:passwort -X GET http://localhost:8443/Settings
Anzeige von Informationen über die Einstellungen:
curl -u user:passwort -X GET http://localhost:8443/Settings!GetMetaInfo

login von accounts:
curl -u user:passwort -X GET http://localhost:8443/bot/accounts/MAGI ... .NET!login
start von accounts:
curl -u user:passwort -X GET http://localhost:8443/bot/accounts/MAGI ... .NET!start

Wer Ahnung von Python hat kann sich auch in der WEB UI anschauen wie die Schnittstelle verwendet wird: https://www.mfbot.de/Download/v5.0.0.0/ ... erface.zip

<---------------------------------------------------------------------->
English version tbd
MFBot 5.x: 63626 CodeZeilen in 338 Dateien

Kein Support über PNs(ausgenommen sind explizit im Forum angeforderte Infos die nicht für den öffentlichen Bereich geeignet sind)
Kein Support für die Shakes & Fidget App
Kein Support für den S&F Browser Client

Gesperrt

Wer ist online?

Mitglieder in diesem Forum: Google [Bot] und 1 Gast