📡 API-Dokumentation – State-Endpunkte

Übersicht

Die folgenden Endpunkte liefern Informationen über den aktuellen Zustand der Hardware-Einheit, einschließlich Build-Version, Modell, SIM-Status sowie API-Spezifikation.

🔍 GET /state

Beschreibung

Ruft allgemeine Informationen über den Build-Zustand der Einheit ab.

Request

• Methode: GET

• Endpoint: /state

• Authentifizierung: ✅ erforderlich (Bearer oder BasicAuth)

• Parameter: Keine

Beispielantwort 200 OK

{
  "iss": "brevis.one",
  "host": "https://<url-unit>",
  "number": "004911111111",
  "unit": {
    "model": "Rack Edition",
    "version": "5.0.0"
  },
  "build": {
    "number": 8,
    "branch": "release/5.0.0",
    "commit": "a3d7280",
    "time": "2020-08-14T21:33:37.061+02:00"
  },
  "licenses": ["string"],
  "sim": {
    "strength": "-81 dBm",
    "state": "SIGNAL_OK"
  }
}

Mögliche Fehlercodes

📄 GET /state/spec.yml

Beschreibung

Liefert die vollständige API-Spezifikation im YAML-Format.

Request

• Methode: GET

• Endpoint: /state/spec.yml

• Authentifizierung: ✅ erforderlich

• Parameter: Keine

Beispielantwort 200 OK

openapi: "3.0.0"
info:
  title: "Brevis REST API"
  version: "5.0.0"
# ...

(Hinweis: Der vollständige YAML-Inhalt wird hier nicht gezeigt, da dies meist eine große Datei ist.)

Mögliche Fehlercodes

🧾 GET /state/spec.json

Beschreibung

Liefert die vollständige API-Spezifikation im JSON-Format.

Request

• Methode: GET

• Endpoint: /state/spec.json

• Authentifizierung: ✅ erforderlich

• Parameter: Keine

Beispielantwort 200 OK

{
  "openapi": "3.0.0",
  "info": {
    "title": "Brevis REST API",
    "version": "5.0.0"
  }
  // ...
}

Mögliche Fehlercodes

📌 Hinweise

• Alle Endpunkte setzen eine gültige Authentifizierung voraus.

• Die YAML- und JSON-Spezifikationen können direkt in Swagger/OpenAPI-Tools integriert werden.

• Die Signalstärke wird in dBm angegeben. Werte von -55 bis -90 gelten als gut. Über -90 bis -105 dBm gelten als schwach.