Einerseits veröffentlicht mimoLive eine UI für die Fernbedienung mit dem Sie eigene Benutzeroberflächen erstellen können, die Sie auf einem Tablet oder einem ähnlichen Gerät zur Fernsteuerung des mimoLive verwenden können.
Darüber hinaus bietet mimoLive Zugriff auf die bloße HTTP API so dass Sie eigene Skripte erstellen können (über bash und locken., AppleScript, eingebaut Automationsebene oder etwas Ähnliches, das mit einer HTTP Server), die verschiedene Aspekte von mimoLive steuern - die Möglichkeiten sind nahezu endlos. (Siehe Beispiele für API Verwendung)
In diesem Thema werden wir uns auf die bloßen HTTP API. Als die API basiert auf dem json:api-Spezifikation machen Sie sich unbedingt damit vertraut, bevor Sie mit dem mimoLive arbeiten API.
*Zusätzlich zur Dokumentation können Sie auch einen Blick auf unsere PHP-Demoskripte auf github werfen
Außerdem gibt es ein Beispiel für Shell und Apple Script.
API Endpunkt
Das mimoLive API ist auf demselben Rechner, auf dem mimoLive läuft (über "localhost") und im lokalen Netzwerk (über ".local") erreichbar.
Wenn aktiviert, bietet mimoLive eine HTTP Server auf "Port 8989".
Die gesamte API Aufrufen wird der Pfad "/api/v1/" vorangestellt. Wenn Sie also eine Liste der geöffneten Dokumente erhalten möchten, rufen Sie "http://localhost:8989/api/v1/documents" auf.
Alle IDs (für Dokumente, Ebenen, etc.) werden gespeichert und auf der Festplatte gehalten, so dass die Festcodierung dieser Werte sicher ist, solange das gleiche Dokument innerhalb von mimoLive verwendet wird.
Authentifizierung
Ab mimoLive 3.1 müssen Sie, wenn der Benutzer die Authentifizierung in den mimoLive-Einstellungen aktiviert hat, das Benutzerpasswort für jede Anfrage an die API was auf zwei Arten geschehen kann:
- Einstellung der benutzerdefinierten HTTP Header "X-MimoLive-Passwort-SHA256: xxxxxxx"
- Anhängen des Abfrageparameters "?pwSHA256=xxxxxxx"
In beiden Fällen muss xxxxxxx durch das ursprüngliche Passwort ersetzt werden (in UTF-8-Kodierung) mit Hashwerten SHA-256 und kodiert als hexadezimale Ziffernfolge.
Um die Entwicklung eigener Skripte und Anwendungen zu vereinfachen, zeigt mimoLive dies API Taste und ermöglicht das Kopieren in die Zwischenablage im Einstellungsfenster Fernbedienungen:
Veraltete Authentifizierungsmethode
Vor der Version 3.1 von mimoLive wurden Anfragen an die API würde mit Hilfe des speziellen HTTP Header "X-MimoLive-Password:" oder den Abfrageparameter "?pw=" bei jeder Anfrage.
Leider wird bei dieser Methode das Kennwort im Klartext über eine potenziell unsichere Netzwerkverbindung gesendet, wodurch vertrauliche Daten preisgegeben werden können, wenn der HTTP API Das Passwort wird an anderer Stelle wiederverwendet.
Obwohl sie weiterhin funktioniert, wird von dieser Authentifizierungsmethode abgeraten und sie könnte in Zukunft abgeschafft werden.
Fehler
Wenn während einer Anfrage ein Fehler auftritt, bricht mimoLive die Bearbeitung dieser Anfrage ab und gibt eine HTTP Antwort mit ihrem Statuscode, der den Fehler angibt. Die Antwort enthält auch eine JSON Nutzlast Array von Fehlerobjekten, die zusätzliche Informationen über jeden aufgetretenen Fehler enthalten:
{
"errors": [
{
"status": "404",
"title": "Not Found",
"description": "The requested object could not be found"
}
]
}Fernzugriff über das Internet
Da die HTTP API wird durch einen in mimoLive eingebauten Webserver ermöglicht, der Fernzugriff auf die HTTP API von jedem beliebigen Ort im Internet ermöglicht werden, indem man dem mimoLive-Computer eine öffentliche IP-Nummer zuweist. Da die HTTP API nicht sehr gut geschützt ist, ist dies eine schlechte Idee. Eine bessere Möglichkeit, den Fernzugriff auf die HTTP API über ein öffentliches Netz ist, um einen sicheren Tunnel zu Ihrem mimoLive-Host-Computer mit ngrok aufbauen.