HTTP-API-Dokumentation

In der HTTP-API-Dokumentation erfahren Sie, wie Sie Ihre Videoanzeigetafel aus der Ferne steuern können, entweder über ein Stream Deck-Gerät, einen curl-Befehlsaufruf über die Kommandozeile oder über eine von Ihnen selbst entwickelte Software.

Eine API (Application Programming Interface) ist ein Element, das anderen Systemen die Möglichkeit bietet, mit ihm zu interagieren. Es gibt viele Arten von APIs, weshalb ich es als „Element“ bezeichnet habe, und es kann viele Arten von Interaktionen ermöglichen: Sie können Daten an es senden, Daten von diesem System sammeln oder es fernsteuern.

In unserem Fall haben wir eine HTTP-API implementiert, was bedeutet, dass wir eine Art Webserver haben, der darauf wartet, Ihre Anfragen zu empfangen, als ob Sie eine Website anfragen würden, und Dinge auf der Grundlage der von Ihnen eingegebenen Adresse zu tun.

Das Wichtigste dabei ist, dass es sich um einen Webserver handelt, so dass Sie HTTP-API-Anfragen mit jedem Programm senden können, das Webseiten anfordern kann (Ihr Lieblingsbrowser, die Anwendung locken. auf Linux und OSX usw.) und, was noch wichtiger ist, Sie können dies von jedem Computer, Tablet oder Mobiltelefon aus tun, das sich im selben Netzwerk befindet, so dass Sie mehrere LDSscoreboards (oder LDSperimetral) von einem zentralen Punkt aus, Ihrem Kontrollzentrum, steuern können.

Um diese HTTP-API aufzurufen, müssen Sie eine URL abfragen (URL ist die Bezeichnung für die Adresse, die sich aus Protokoll, Computer, Port und Anfrage zusammensetzt), als wäre sie eine „Webseite“. Aber wo ist diese Webseite? Ich bringe alles durcheinander! Am einfachsten ist es, wenn Sie mit Ihrem Lieblingsbrowser die gewünschte Anfrage öffnen. Die Adresse sieht dann so aus: https://IP_DEL_ORDENADOR:PUERTO_CONFIGURADO/PETICION_A_EFECTUAR

Daher und zusammenfassend:

• Die IP-Adresse des Computers hängt von der Netzwerkkonfiguration des Geräts ab. Wir empfehlen Ihnen, sie fest einzustellen, um zu verhindern, dass sie sich ändert und Anfragen an einen anderen Computer weitergeleitet werden, ohne dass Sie es bemerken.
• Der Anschluss ist in der Terminalkonfiguration mit einem roten Pfeil gekennzeichnet.
• Die Anfrage hängt von dem Auftrag ab, den Sie LDSscoreboard erteilen möchten (wir werden dies in Kürze sehen).

Mit dieser HTTP-API-Dokumentation können Sie lernen, wie Sie die Videoanzeigetafel auf einfache Weise fernsteuern können.

Im gezeigten Fall lautet die IP unseres Computers 192.168.1.35 und der konfigurierte Port 8080.

Ziel ist es, eine API für alle LDSscoreboard-Steuerungsbefehle außer der Bearbeitung von Inhalten zu haben. Auf diese Weise können Sie alle gewünschten Bildschirme zentral steuern, Werbeinhalte veröffentlichen oder Elemente mit Lesezeichen versehen.

Schauen wir uns ein Beispiel an, um besser zu verstehen, wie die HTTP-API wie in dieser Dokumentation beschrieben funktioniert. Nehmen wir an, wir haben eine Markierung definiert, die eine Folie mit dem Namen „Folie1“ enthält. Um das System aufzufordern, Folie1 zu öffnen, sollten wir die IP des Computers und den Port kennen, da wir den Namen bereits kennen.

Wenn wir das Bild oben auf der Seite nehmen, sehen wir, dass wir die IP 192.168.1.35 und den Port 8080 haben, also sollten wir eine HTTP-Anfrage (Öffnen der Seite) an die Adresse http://192.168.1.35:8080/pcontrol/show_slide/slide1 stellen.

Zu diesem Zweck können wir einen Browser öffnen und die Adresse in die Adressleiste eingeben:

Wenn nun LDSscoreboard läuft, sollte die Folie mit dem Namen slide1 aktiv werden.

WICHTIG

Wenn der Name der Folie ein Leerzeichen enthält, da es sich um ein Sonderzeichen handelt, muss es durch %20 ersetzt werden, d. h. „meine Folie“ wird als „meine%20Folie“ übersetzt.

Natürlich sind Sie nicht darauf beschränkt, HTTP-Aufrufe von einem Browser aus zu tätigen. Wir haben es so gemacht, weil es ein Werkzeug ist, das Sie sicher zur Hand haben und kennen, aber es gibt noch viele andere Möglichkeiten, es zu tun.

locken.

curl ist ein quelloffenes Werkzeug für HTTP-Anfragen. Es ist auf Linux, OSX und auch auf den neuesten Versionen von Windows 10 verfügbar. Es ist sehr einfach zu bedienen, wie die folgende Abbildung zeigt:

Javascript

Sie können ein Javascript-Programm mit jquery erstellen, bei dem ein HTTP-Aufruf erfolgt, zum Beispiel mit diesem Code:

timer_identifier=“meine Zeitschaltuhr“;

$.getJSON(`/pcontrol/start_timer/${timer_identifier}`)
.done(function (data) {
if (data.status != 0) {
console.error(`Fehler beim Starten des Timers: ${JSON.stringify(data)} `);
}
})
.fail(function (err) {
if (err.status != 200)
console.error(`Fehler beim Starten des Timers [${JSON.stringify(err)}]`);
});

und jede Programmiersprache erlaubt es Ihnen, solche Aufrufe zu machen.

Seite aktualisiert am 25/4/2024