⚙️ brevis.one – API Konfigurationsdokumentation – Brevis.one

Diese Anleitung beschreibt die Konfigurationsmöglichkeiten der brevis.one RESTful API über das Web-Interface. Sie deckt Authentifizierung, Token-Verwaltung, Zugriffskontrolle per IP und SDK-Downloads ab.

🔐 Allgemeine Einstellungen

Einstellung	Beschreibung
HTTP Basic Authentication aktivieren/deaktivieren	Schaltet die klassische HTTP Basic Authentifizierung ein oder aus.
Interaktive API aktivieren/deaktivieren	Ermöglicht den Zugriff auf die interaktive API-Dokumentation (z. B. Swagger UI).
Button: `Testen der interaktiven API`	Öffnet die interaktive API-Dokumentation zur Testzwecken im Browser.

🔑 JSON Web Tokens (JWT)

Token-Zeitüberschreitung

Einstellung: Zeitüberschreitung für generierte JWT-Tokens (Standard: 15 Minuten)
Wirkung: Betrifft nur neu ausgestellte Tokens. Bestehende Tokens bleiben unverändert gültig.

Token-Invalidierung

Button: Alle Tokens ungültig machen
Funktion: Hebt sofort die Gültigkeit aller bisher generierten Tokens auf. Nützlich z. B. bei Sicherheitsvorfällen.

🌐 API-Zugang (IP-Zugriffskontrolle)

IP-Filterung

Eingabefeld: Client blacklist/whitelist
Unterstützt Wildcard-Matching, z. B. 192.168.*.*
Einträge in beiden Listen sind stets erlaubt

Modi

Blacklist: Alle Clients dürfen zugreifen, außer die gelisteten IPs.
Whitelist: Nur die gelisteten IPs dürfen zugreifen.

💡 Hinweis: Eine IP in beiden Listen wird automatisch erlaubt.

📥 Client SDK Herunterladen

Die API basiert auf der OpenAPI-Spezifikation (OAS v3). Die Spezifikation ist verfügbar als:

🔹 YAML: /state/spec.yml
🔹 JSON: /state/spec.json

Unterstützte SDKs

Diese SDKs können direkt über die Oberfläche geladen werden:

Sprache	SDK-Link
Python	`brevis.one Python SDK`
Java	`brevis.one Java SDK`
C#	`brevis.one C# SDK`
PHP	`brevis.one PHP SDK`

Die SDKs wurden mit dem Swagger Codegen Tool generiert und sind einsatzbereit für die jeweilige Programmiersprache.

✅ Best Practices

Aktiviere JWT für moderne, sichere Authentifizierung.
Nutze die Whitelist, um die API nur für autorisierte Netzwerke zu öffnen.
Verwalte Tokens zentral und entziehe im Zweifel alle Berechtigungen mit einem Klick.

Verknüpfung mit