{"id":32486,"date":"2023-03-08T16:31:06","date_gmt":"2023-03-08T15:31:06","guid":{"rendered":"https:\/\/mimolive.com\/?post_type=user-manual&#038;p=32486"},"modified":"2024-10-08T09:55:45","modified_gmt":"2024-10-08T07:55:45","slug":"http-api","status":"publish","type":"user-manual","link":"https:\/\/mimolive.com\/de\/user-manual\/remote-control-automation\/http-api\/","title":{"rendered":"HTTP-API"},"content":{"rendered":"<p>Einerseits ver\u00f6ffentlicht mimoLive eine <a href=\"https:\/\/mimolive.com\/de\/benutzerhandbuch\/fernbedienungsflachen\/\">UI f\u00fcr die Fernbedienung<\/a> mit dem Sie eigene Benutzeroberfl\u00e4chen erstellen k\u00f6nnen, die Sie auf einem Tablet oder einem \u00e4hnlichen Ger\u00e4t zur Fernsteuerung des mimoLive verwenden k\u00f6nnen.<\/p>\n\n\n\n<p>Dar\u00fcber hinaus bietet mimoLive Zugriff auf die blo\u00dfe <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> so dass Sie eigene Skripte erstellen k\u00f6nnen (\u00fcber <strong>bash<\/strong> und <strong>locken.<\/strong>, <strong>AppleScript<\/strong>, eingebaut <a href=\"https:\/\/mimolive.com\/de\/benutzerhandbuch\/automatisierung\/\">Automationsebene<\/a> oder etwas \u00c4hnliches, das mit einer <span class=\"caps\">HTTP<\/span> Server), die verschiedene Aspekte von mimoLive steuern - die M\u00f6glichkeiten sind nahezu endlos. (Siehe <a href=\"https:\/\/mimolive.com\/de\/benutzerhandbuch\/beispiele-fur-die-verwendung-von-api\/\">Beispiele f\u00fcr <span class=\"caps\">API<\/span> Verwendung<\/a>)<\/p>\n\n\n\n<p>In diesem Thema werden wir uns auf die blo\u00dfen <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span>. Als die <span class=\"caps\">API<\/span> basiert auf dem <a href=\"http:\/\/jsonapi.org\/\" target=\"_blank\" rel=\"noreferrer noopener\">json:api-Spezifikation<\/a> machen Sie sich unbedingt damit vertraut, bevor Sie mit dem mimoLive arbeiten <span class=\"caps\">API<\/span>.<\/p>\n\n\n\n<p>*Zus\u00e4tzlich zur Dokumentation k\u00f6nnen Sie auch einen Blick auf unsere PHP-Demoskripte auf github werfen<\/p>\n\n\n\n<p><br>Au\u00dferdem gibt es ein Beispiel f\u00fcr Shell und Apple Script.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"api-endpoint\"><span class=\"caps\">API<\/span> Zugang<\/h3>\n\n\n\n<p>Das mimoLive <span class=\"caps\">API<\/span> ist auf demselben Rechner, auf dem mimoLive l\u00e4uft (\u00fcber \"localhost\") und im lokalen Netzwerk (\u00fcber \".local\") erreichbar.<\/p>\n\n\n\n<p>Wenn aktiviert, bietet mimoLive eine <span class=\"caps\">HTTP<\/span> Server auf \"Port 8989\".<\/p>\n\n\n\n<p>Die gesamte <span class=\"caps\">API<\/span> Aufrufen wird der Pfad \"\/api\/v1\/\" vorangestellt. Wenn Sie also eine Liste der ge\u00f6ffneten Dokumente erhalten m\u00f6chten, rufen Sie \"http:\/\/localhost:8989\/api\/v1\/documents\" auf.<\/p>\n\n\n\n<p>Alle IDs (f\u00fcr Dokumente, Ebenen, Quellen, Ausgabeziele usw.) werden gespeichert und bleiben auf der Festplatte erhalten, so dass die Festcodierung dieser Werte sicher ist, solange dasselbe Dokument in mimoLive verwendet wird.<br><br>Bitte beachten Sie <a href=\"https:\/\/mimolive.com\/de\/benutzerhandbuch\/personalisierung\/http-api\/endpunkte\/\" data-type=\"user-manual\" data-id=\"32488\">API-Endpunkte<\/a> um mehr \u00fcber alle angebotenen Endpunkte zu erfahren.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"authentication\">Authentifizierung<\/h3>\n\n\n\n<p>Ab mimoLive 3.1 m\u00fcssen Sie, wenn der Benutzer die Authentifizierung in den mimoLive-Einstellungen aktiviert hat, das Benutzerpasswort f\u00fcr jede Anfrage an die <span class=\"caps\">API<\/span> was auf zwei Arten geschehen kann:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Einstellung der benutzerdefinierten <span class=\"caps\">HTTP<\/span> Header \"X-MimoLive-Passwort-SHA256: xxxxxxx\"<\/li>\n\n\n\n<li>Anh\u00e4ngen des Abfrageparameters \"?pwSHA256=xxxxxxx\"<\/li>\n<\/ul>\n\n\n\n<p>In beiden F\u00e4llen muss xxxxxxx durch das urspr\u00fcngliche Passwort ersetzt werden (in <span class=\"caps\">UTF<\/span>-8-Kodierung) mit Hashwerten <span class=\"caps\">SHA<\/span>-256 und kodiert als hexadezimale Ziffernfolge.<br>Um die Entwicklung eigener Skripte und Anwendungen zu vereinfachen, zeigt mimoLive dies <span class=\"caps\">API<\/span> Taste und erm\u00f6glicht das Kopieren in die Zwischenablage im Einstellungsfenster Fernbedienungen:<\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img fetchpriority=\"high\" decoding=\"async\" width=\"1000\" height=\"448\" src=\"https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/dddc6bf5-964b-493c-b35e-ee5b37e44e40.png\" alt=\"\" class=\"wp-image-32487\" srcset=\"https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/dddc6bf5-964b-493c-b35e-ee5b37e44e40.png 1000w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/dddc6bf5-964b-493c-b35e-ee5b37e44e40-300x134.png 300w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/dddc6bf5-964b-493c-b35e-ee5b37e44e40-768x344.png 768w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/dddc6bf5-964b-493c-b35e-ee5b37e44e40-18x8.png 18w\" sizes=\"(max-width: 1000px) 100vw, 1000px\" \/><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"deprecated-authentication-method\">Veraltete Authentifizierungsmethode<\/h4>\n\n\n\n<p>Vor der Version 3.1 von mimoLive wurden Anfragen an die <span class=\"caps\">API<\/span> w\u00fcrde mit Hilfe des speziellen <span class=\"caps\">HTTP<\/span> Header \"X-MimoLive-Password:\" oder den Abfrageparameter \"?pw=\" bei jeder Anfrage.<br>Leider wird bei dieser Methode das Kennwort im Klartext \u00fcber eine potenziell unsichere Netzwerkverbindung gesendet, wodurch vertrauliche Daten preisgegeben werden k\u00f6nnen, wenn der <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> Das Passwort wird an anderer Stelle wiederverwendet.<br>Obwohl sie weiterhin funktioniert, wird von dieser Authentifizierungsmethode abgeraten und sie k\u00f6nnte in Zukunft abgeschafft werden.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"errors\">Fehler<\/h3>\n\n\n\n<p>Wenn w\u00e4hrend einer Anfrage ein Fehler auftritt, bricht mimoLive die Bearbeitung dieser Anfrage ab und gibt eine <span class=\"caps\">HTTP<\/span> Antwort mit ihrem Statuscode, der den Fehler angibt. Die Antwort enth\u00e4lt auch eine <span class=\"caps\">JSON<\/span> Nutzlast Array von Fehlerobjekten, die zus\u00e4tzliche Informationen \u00fcber jeden aufgetretenen Fehler enthalten:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>{\n  \"errors\": &#91;\n    {\n      \"status\": \"404\",\n      \"title\": \"Not Found\",\n      \"description\": \"The requested object could not be found\"\n    }\n  ]\n}<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"remote-access\">Fernzugriff \u00fcber das Internet<\/h3>\n\n\n\n<p>Da die <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> wird durch einen in mimoLive eingebauten Webserver erm\u00f6glicht, der Fernzugriff auf die <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> von jedem beliebigen Ort im Internet erm\u00f6glicht werden, indem man dem mimoLive-Computer eine \u00f6ffentliche IP-Nummer zuweist. Da die <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> nicht sehr gut gesch\u00fctzt ist, ist dies eine schlechte Idee. Eine bessere M\u00f6glichkeit, den Fernzugriff auf die <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> \u00fcber ein \u00f6ffentliches Netz ist, um <a href=\"https:\/\/mimolive.com\/de\/benutzerhandbuch\/fernsteuerungsoberflachen-und-http-api-aus-der-ferne-aufrufen\/\">einen sicheren Tunnel zu Ihrem mimoLive-Host-Computer mit ngrok aufbauen<\/a>.<\/p>","protected":false},"excerpt":{"rendered":"<p>On one hand, mimoLive publishes a Remote Control UI which you can use to create custom user interfaces that you can use on a tablet or similar device to remote control mimoLive. Additionally, mimoLive provides access to the bare HTTP API so you can create custom scripts (via bash and curl, AppleScript, build-in Automation Layer [&hellip;]<\/p>","protected":false},"author":3,"featured_media":0,"parent":40865,"menu_order":2,"template":"","meta":{"_acf_changed":false,"_angie_page":false,"_lmt_disableupdate":"","_lmt_disable":"","footnotes":""},"categories":[258],"tags":[],"class_list":["post-32486","user-manual","type-user-manual","status-publish","hentry","category-manual"],"acf":[],"_links":{"self":[{"href":"https:\/\/mimolive.com\/de\/wp-json\/wp\/v2\/user-manual\/32486","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/mimolive.com\/de\/wp-json\/wp\/v2\/user-manual"}],"about":[{"href":"https:\/\/mimolive.com\/de\/wp-json\/wp\/v2\/types\/user-manual"}],"author":[{"embeddable":true,"href":"https:\/\/mimolive.com\/de\/wp-json\/wp\/v2\/users\/3"}],"version-history":[{"count":1,"href":"https:\/\/mimolive.com\/de\/wp-json\/wp\/v2\/user-manual\/32486\/revisions"}],"predecessor-version":[{"id":39706,"href":"https:\/\/mimolive.com\/de\/wp-json\/wp\/v2\/user-manual\/32486\/revisions\/39706"}],"up":[{"embeddable":true,"href":"https:\/\/mimolive.com\/de\/wp-json\/wp\/v2\/user-manual\/40865"}],"wp:attachment":[{"href":"https:\/\/mimolive.com\/de\/wp-json\/wp\/v2\/media?parent=32486"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/mimolive.com\/de\/wp-json\/wp\/v2\/categories?post=32486"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/mimolive.com\/de\/wp-json\/wp\/v2\/tags?post=32486"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}