Die HTTP-API definiert verschiedene Module, die mit Hilfe von Methoden Bild-, Stream- oder Videodaten eines Kamerasystems ausliefern.
Die Aufgabe der API besteht darin, den Abruf der Bild- und Videodaten eines Kamerasystems nach festen Regeln zu ermöglichen. Jedes Kamerasystem wird dabei über einen sechstelligen Code - den sogenannten Shorttag - identifiziert. Mit Hilfe eines HTTP-GET-Requests, der den Shorttag enthält, werden Image-, Video-, oder JSON-Ressourcen zurückgegeben.
Wenn Bilder oder Informationen von einer passwortgeschützten Kamera abgerufen werden sollen, wechselt die HTTP-API automatisch zum Login-Screen. Nach dem erfolgreichen Login, wird die ursprüngliche URL aufgerufen.
Die API liefert auch bei großen Bildserien schnell die gewünschten Daten, da sie auf einen effizienten Speicherdienst zugreift.
Der Aufruf der HTTP-API beginnt mit dem URL-Stub / gefolgt von
jeweils durch Slashes getrenntem Modulnamen (mod), dem Methodennamen (meth), dem Kamera-Shorttag (st) und den
Parameterwerten der gewählten Methode (par). Die Syntax sehen Sie hier:
https://pool02.mietkamera.de/mod/meth/st/par
Ausgabe von Einzelbildern einer Kamera in verschiedenen Größen oder Informationen über die gespeicherten Bilder einer Kamera im JSON-Format. Auch ein Livebild kann abgerufen werden, wenn die Kamera aktiv ist.
Ausgabe von MJPEG-Streams die aus den gespeicherten Bildern erzeugt werden. Die Auflösung und der Datumsbereich der Bilder aus denen der Stream bestehen soll, können angegeben werden.
Ausgabe von Videos einer Kamera oder Informationen über die vorhandenen Videos einer Kamera im JSON-Format.
Ausgabe von kompletten HTML-Seiten mit Archivbildern, Videos und Kombinationen daraus, die der Kunde als Projektseite für den Zugriff auf seine Bilddaten verwenden kann. Die Seiten können passwortgeschützt sein.
Login und Statusinformationen.
Ausgabe von Statusinformationen für eine Kamera im JSON-Format.
Wenn Bilder oder Informationen von einer Kamera abgerufen werden sollen, die passwortgeschützt ist, gibt es die Möglichkeit vorab das Login-Modul direkt aufzurufen. Es liefert eine auth-Methode, um die Anmeldung durchzufüren.
Die Kamerasysteme speichern die Einzelbilder der Kameras in Abhängigkeit vom eingesetzten Kameratyp entweder in einem 4:3-Format von 2018x1536 oder 3072x2048 oder einem 16:9-Formate in 1280x720 oder 1920x1080 Pixeln ab. Beim Abruf der Bilder können auch andere Formate angegeben werden. Die Angabe des Formats kann dabei entweder in Pixeln oder in einer Abkürzung erfolgen.
Folgende Formatangaben sind zulässig: 320x240 (cif), 512x384 (xcif), 640x480 (vga), 768x576 (d1pal), 800x600 (svga), 1024x768 (xvga), 1280x960 (mega), 2048x1536 (qxga), 2592x1944 (5mp), 3072x2048 (6mp), 640x360 (qhd), 1280x720 (hd720), 1920x1080 (hd), 2560x1440 (xga), 3840x2160 (4k)