Zum Hauptinhalt gehen

🧬 API-Schemas – Datenmodelle & Payloads

Brevis Support
Aktualisiert

Im Folgenden findest du alle relevanten Datenstrukturen (Schemas), die in den Requests und Responses der brevis.one RESTful API verwendet werden. Diese dienen sowohl der Validierung als auch der Spezifikation in Tools wie Swagger, Postman oder OpenAPI-Generatoren.

🔐 TokenSigninPayload

Verwendung: Beim Login – Übergabe von Benutzername & Passwort.

Feld Typ Beschreibung
username String Erforderlich, min. 4 Zeichen, nur alphanumerisch (z. B. taco)
password String Erforderlich, min. 4 Zeichen, z. B. bell

🔐 TokenSigninResponse

Verwendung: Antwort nach erfolgreichem Login (JWT-Authentifizierung).

Feld Typ Beschreibung
jwt String Das ausgestellte Token (JWT). Kann zur Rechteprüfung decodiert werden.
expireAt Integer UNIX-Timestamp (z. B. 1599732636) – Zeitpunkt, an dem das Token abläuft.

👤 CurrentUser

Verwendung: Wird über /user/me zurückgegeben.

Feld Typ Beschreibung
id Integer Benutzer-ID
name String Benutzername
rights Array Rechte des Nutzers, z. B. ["usermgmt", "groupmgmt"]

👥 ContactGroupPayload

Verwendung: Beim Erstellen oder Aktualisieren einer Kontaktgruppe.

Feld Typ Beschreibung
name String Pflichtfeld, min. 2 Zeichen, nur alphanumerisch (z. B. monitoring)

👥 ContactGroup

Verwendung: Datenstruktur einer bestehenden Kontaktgruppe.

Feld Typ Beschreibung
id Integer ID der Gruppe
name String Anzeigename der Gruppe

📇 ContactPayload

Verwendung: Zum Erstellen oder Aktualisieren eines Kontakts.

Feld Typ Beschreibung
name String Pflichtfeld, min. 1 Zeichen, z. B. John Doe
number String Telefonnummer, min. 5 Zeichen
email String Gültige E-Mail-Adresse
groups Array[Int] Liste von Gruppen-IDs

📇 Contact

Verwendung: Struktur eines gespeicherten Kontakts.

Feld Typ Beschreibung
id Integer ID des Kontakts
type String Typ des Kontakts (z. B. user)
name String Vollständiger Name
number String Telefonnummer
email String E-Mail-Adresse
groups Array Zugehörige Gruppen (mit ID und Name)

✉️ MessagePayload

Verwendung: Zum Versenden von Nachrichten.

Feld Typ Beschreibung
recipients Array[Object] Pflichtfeld – Empfängerangaben (z. B. Gruppen oder einzelne Nutzer)
text String Nachrichtentext (mindestens 1 Zeichen)
provider String sms (Standard) oder telegram
type String default, flash, ring – siehe unten

type-Varianten (nur SMS):

  • default: Normale SMS

  • flash: Wird direkt auf dem Display angezeigt, nicht gespeichert

  • ring: Löst stummen Anruf aus – ideal für Warnungen

✉️ Message

Verwendung: Struktur einer empfangenen/gesendeten Nachricht.

Feld Typ Beschreibung
id String Nachricht-ID (alphanumerisch)
type String Status: sent, failed, queued, incoming
text String Nachrichtentext
provider String sms oder telegram
timestamp String UNIX-Timestamp
isFlash Boolean Ob es sich um eine Flash-SMS handelt
isRing Boolean Ob es sich um einen stummen Anruf handelt
senders Array Liste der Absender
recipients Array Liste der Empfänger

🛠️ StateResponse

Verwendung: Rückgabe von /state – Systemstatus.

Feld Beschreibung
iss Aussteller (brevis.one)
host Geräte-URL
number Gerätenummer
unit Hardwaremodell & Version
build Build-Informationen (Branch, Commit, Time)
licenses Array aktiver Lizenzen
sim SIM-Zustand inkl. Signalstärke (-81 dBm)

🚫 Error

Verwendung: Standard-Fehlerrückgabe bei fehlerhaften Anfragen.

Feld Typ Beschreibung
code Integer Fehlercode
message String Fehlerbeschreibung
reasons Array Detailinformationen zur Fehlerursache

Verknüpfung mit

Kommentare

0 Kommentare

Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.