INSTAR Cloud API

Um auf die Cloud-API zuzugreifen, müssen Sie derzeit manuell ein Zugangstoken erstellen:

  • https://api.cloud.instar.de/api/v1/token?username=xxxx@email.com&password=xxxxxx

Der Benutzername und das Kennwort sind die E-Mail-Adresse und das Kennwort, mit denen Sie sich bei Ihrem Cloud-Konto anmelden.

HINWEIS: Sie müssen Ihre E-Mail-Adresse und Ihr Passwort URL-sicher machen, bevor Sie sie in einem URL-Query verwenden!

Das Token hat derzeit standardmäßig eine Verfallszeit von 2 Stunden. Die Antwort auf die obige Anfrage sieht wie folgt aus:

{
    "status": 0,
    "message": "ok",
    "data": {
        "token": "baa0187e7f92b7216ac5f75e10890fdf1dd74d48",
        "token_expiration_time": 1623754949
    }
}
Parametername Typ Beschreibung
status Int Fehlercode, 0 bedeutet, dass kein Fehler aufgetreten ist
message String Fehlermeldung
Token String API-Token
token_expiration_time Int Token-Ablaufzeit, Standardwert ist 2 Stunden

Nachdem Sie das Token erhalten haben, können Sie es verwenden, um auf die Liste der Alarme für Ihr Konto zuzugreifen:

  • https://api.cloud.instar.de/api/v1/alarm/list?page_no=1&page_size=1&token=xxxxxx

Im obigen Beispiel werden die beiden Queries page_no und page_size verwendet, um die Größe der Antwort zu begrenzen - in diesem Fall erhalten Sie nur das letzte aufgezeichnete Alarmereignis. Sie können die folgenden Queries verwenden, um die API-Anfrage anzupassen:

Parameter Erforderlich Typ Beschreibung
token Yes String Sie können den Token erhalten, indem Sie api User token aufrufen.
is_falsealarm No Int Erhält Falschalarm-Video oder nicht, sein Wert muss einer der folgenden sein: 0/1. 0 bedeutet, dass das Alarmvideo erhalten wird, 1 bedeutet, dass das Falschalarmvideo erhalten wird. Hinweis: Nur wenn is_falsealarm gleich 0 ist, können die Filter Person, Fahrzeug, Tier und Unbekannt als Filter gesetzt werden, ansonsten ist das Ergebnis leer.
is_viewed No Int Gesehenes Video erhalten oder nicht, sein Wert muss einer von ihnen sein: 0/1. 0 bedeutet ungesehenes Video, 1 bedeutet angesehenes Video
is_locked No Int Gesperrt oder nicht, sein Wert muss einer von ihnen sein: 0/1. 0 bedeutet ungesperrtes Video, 1 bedeutet gesperrtes Video erhalten
is_starred No Int Video mit Sternchen bekommen oder nicht, der Wert muss einer von ihnen sein: 0/1. 0 bedeutet ungestarbtes Video, 1 bedeutet gestarbtes Video erhalten
attr_link No Int Kombiniere gesperrt und mit Sternchen versehen oder nicht, sein Wert muss einer von beiden sein: 0/1. 0 bedeutet, dass das Ergebnis weder gesperrt noch mit Sternchen versehen ist, 1 bedeutet, dass das Ergebnis sowohl gesperrt als auch mit Sternchen versehen ist.
person No Int Sein Wert muss 1 sein. Das bedeutet, dass Sie das Video mit der Person erhalten. Hinweis: Nur wenn is_falsealarm gleich 0 ist, können Sie diesen Filter setzen, andernfalls wird das Ergebnis leer sein.
vehicle No Int Sein Wert muss 1 sein. Dies bedeutet, dass das Video mit dem Fahrzeug abgerufen wird. Hinweis: nur wenn is_falsealarm gleich 0 ist, können Sie diesen Filter setzen, ansonsten ist das Ergebnis leer.
animal No Int Get Video mit Tier oder nicht. sein Wert muss 1 sein. dies bedeutet, get Video mit Tier. Hinweis: nur wenn is_falsealarm gleich 0 ist, können Sie diesen Filter setzen, ansonsten ist das Ergebnis leer.
unknown No Int Sein Wert muss 1 sein. Dies bedeutet, dass Sie ein Video mit einem unbekannten Tier erhalten. Hinweis: nur wenn is_falsealarm gleich 0 ist, können Sie diesen Filter setzen, sonst ist das Ergebnis leer.
object_link No Int Kombiniere Person, Fahrzeug und Tier oder nicht, der Wert muss einer von ihnen sein: 0/1. 0 bedeutet das Ergebnis einschließlich Person oder Fahrzeug oder Tier (wenn sie wie oben eingestellt sind), 1 bedeutet das Ergebnis einschließlich Person und Fahrzeug und Tier (wenn sie wie oben eingestellt sind)
Lizenz No String Lizenznummer
date No String Das spezifische Datum, es werden alle Alarme dieses Tages ermittelt, z.B.: 2020-10-01. Hinweis: Wenn das Datum verwendet wird, werden andere Datumsfilter wie start_date, end_date, start_time und end_time ignoriert.
Startdatum Nein String Startdatum, z.B.: 2020-10-18
Enddatum Nein String Enddatum, z.B.: 2020-11-20
start_time No String Startzeit: 08:00
end_time No String Endzeit: 18:00
time_interval No Int Verwendet die Zeit als tägliche Zeitspanne, der Wert muss 0/1 sein. 0 bedeutet, dass alle Videos von der Startzeit des Startdatums bis zur Endzeit des Enddatums abgerufen werden. 1 bedeutet, dass nur diese Alarmvideos zwischen der Startzeit und der Endzeit eines jeden Tages abgerufen werden.
cam_id No Int Kamera ID
camset_id No Int Kameraset-ID. Hinweis: Wenn die Kameraset-ID verwendet wird, wird die Kamera-ID ignoriert.
page_no No Int Seitennummer
page_size No Int Seitengröße

Und eine typische API-Antwort sieht so aus:

{
    "status": 0,
    "message": "ok",
    "data": {
        "totalCount": 299,
        "totalPages": 299,
        "alarmList": [
            {
                "alarm_id": 1333410,
                "start": "2020-11-18 16:36:04",
                "cam_id": 482,
                "name": "New one",
                "object_detection": 0,
                "is_viewed": 0,
                "is_locked": 0,
                "is_starred": 0,
                "is_falsealarm": 1,
                "object": 3,
                "video": "https://api.cloud.instar.de/api/v1/video/alarm
/1333410.mp4",
                "video_poster": "https://api.cloud.instar.de/api/v1/poster/
alarm/1333410.jpg"
            }
        ]
    }
}
Parameter Typ Beschreibung
status Int Fehlercode, 0 bedeutet, dass kein Fehler aufgetreten ist
message String Fehlermeldung
totalCount Int Gesamtzahl der Alarme
totalPages Int Gesamtseiten der Alarme
alarmList String Es ist ein Array, das alle Alarme enthält, wenn es keine Alarme gibt, ist das Array leer.
alarm_id Int Alarm ID
start String Die Erstellungszeit des Alarms
cam_id Int Kamera-ID
name String Kameraname
object_detection Int Wenn die Kamera die Objekterkennung aktiviert hat oder nicht, muss der Wert einer von ihnen sein: 0/1. 0 bedeutet deaktiviert, 1 bedeutet aktiviert.
is_viewed Int Wenn der Alarm gesehen wurde oder nicht, muss der Wert einer von ihnen sein: 0/1. 0 bedeutet ungesehen, 1 bedeutet gesehen
is_locked Int
is_starred Int Ist der Alarm gestartet oder nicht, muss sein Wert einer von ihnen sein: 0/1. 0 bedeutet ungestarbt, 1 bedeutet gestarbt
is_falsealarm Int Wenn der Alarm ein Fehlalarm ist oder nicht, muss sein Wert einer von ihnen sein: 0/1. 0 bedeutet kein Fehlalarm, 1 bedeutet Fehlalarm
object Int Welches Objekt wird im Alarmvideo erkannt, der Wert muss einer der folgenden sein: -2/0/1/2/3/4/5/6/7, -2 bedeutet keine Objekterkennung im Alarmvideo, 0 bedeutet unbekannt, 1 bedeutet Person, 2 bedeutet Fahrzeug, 3 bedeutet Person & Fahrzeug, 4 bedeutet Tier, 5 bedeutet Person & Tier, 6 bedeutet Fahrzeug & Tier, 7 bedeutet Person, Fahrzeug & Tier. Hinweis: nur is_falsealarm ist gleich 0, dann ist das Objekt gültig.
video String Videolink, muss nach dem Videolink ein Token hinzugefügt werden, um auf das Video zuzugreifen. Wie: https://api.cloud.instar.de/api/v1/video/alarm/1333410.mp4?token=xxxxx
video_poster String Video-Poster-Link, muss ein Token nach dem Video-Poster-Link hinzugefügt werden, um auf das Poster zuzugreifen. Zum Beispiel: https://api.cloud.instar.de/api/v1/poster/alarm/1333410.jpg?token=xxxxxx

Um entweder den Alarm-Snapshot oder das gesamte Alarmvideo herunterzuladen, müssen Sie das generierte Token an Ihre Anfrage anhängen:

  • https://api.cloud.instar.de/api/v1/video/alarm/1333410.mp4?token=xxxxxx
  • https://api.cloud.instar.de/api/v1/poster/alarm/1333410.jpg?token=xxxxxx