Lizenzverwaltung

Diese Endpoints verwalten die IDIAL-Lizenz. Die Lizenz steuert, welche Features verfügbar sind und wie viele Endpoints (OPC UA Geräte) verwaltet werden können. Das Ergebnis der Lizenzvalidierung wird für eine Stunde zwischengespeichert.

hinweis

Diese Endpoints sind in der bisherigen bxc-Dokumentation nicht enthalten. Sie dokumentieren ein Feature, das nach dem letzten Stand der bxc-Dokumentation eingeführt wurde.

POST /systeminfo/lic

Installiert eine Lizenz. Die Lizenz wird in der Datenbank gespeichert und sofort validiert. Das Validierungsergebnis wird in der Antwort zurückgegeben.

Authentifizierung: X-API-Key erforderlich (Feature-Prüfung wird für diesen Endpoint übersprungen)

Anfrage

curl -X POST http://localhost:5000/systeminfo/lic \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"license_b64": "eyJsaWNlbnNlIjogIi4uLiJ9..."}'

Anfragefelder

Feld	Typ	Pflicht	Beschreibung
license_b64	string	Ja	Base64-kodierter Inhalt der .lic-Datei.

Antwort 201

{
  "validation_success": true,
  "validation_message": null,
  "company": "Example GmbH",
  "features": ["core", "enterprise_user_management"],
  "feature_count": 2,
  "licensed_endpoints": 50,
  "validity_start": "2026-01-01",
  "validity_end": "2027-01-01",
  "product": "IDIAL",
  "product_version": "1",
  "license_type": "commercial",
  "is_currently_valid": true,
  "days_until_expiry": 241,
  "is_expired": false
}

Antwortfelder

Feld	Typ	Beschreibung
validation_success	boolean	Gibt an, ob die Lizenz gültig ist.
validation_message	string | null	Fehler- oder Informationsmeldung bei fehlgeschlagener Validierung.
company	string | null	Name des lizenzierten Unternehmens.
features	string[]	Liste der lizenzierten Feature-Bezeichner.
feature_count	integer | null	Gesamtanzahl der lizenzierten Features.
licensed_endpoints	integer | null	Maximale Anzahl verwaltbarer OPC UA Endpoints.
validity_start	string | null	Beginn der Lizenzgültigkeit.
validity_end	string | null	Ende der Lizenzgültigkeit.
product	string | null	Produktname.
product_version	string | null	Produktversionsstring.
license_type	string | null	Lizenztyp (z. B. "commercial", "trial").
is_currently_valid	boolean | null	Gibt an, ob die Lizenz zum aktuellen Zeitpunkt gültig ist.
days_until_expiry	integer | null	Tage bis zum Ablauf der Lizenz.
is_expired	boolean | null	Gibt an, ob die Lizenz bereits abgelaufen ist.

Antwort 400

{"error": "license_b64 is not valid base64"}

---

GET /systeminfo/lic

Validiert die aktuell installierte Lizenz und gibt deren Details zurück.

Authentifizierung: X-API-Key erforderlich

Anfrage

curl -X GET http://localhost:5000/systeminfo/lic \
  -H "X-API-Key: your-api-key"

Antwort 200

Die Antwort entspricht dem Format von POST /systeminfo/lic.

Antwort 404

{"error": "No license stored"}

---

DELETE /systeminfo/lic

Entfernt die installierte Lizenz aus der Datenbank. Nach der Löschung geben alle feature-gesicherten Endpoints 403 zurück, bis eine neue Lizenz installiert wird.

Authentifizierung: X-API-Key erforderlich

Anfrage

curl -X DELETE http://localhost:5000/systeminfo/lic \
  -H "X-API-Key: your-api-key"

Antwort 200

{
  "validation_success": false,
  "validation_message": "License removed",
  "features": []
}

warnung

Das Löschen der Lizenz deaktiviert sofort alle feature-gesicherten Endpoints. Stellen Sie sicher, dass eine Ersatzlizenz verfügbar ist, bevor Sie die aktuelle Lizenz in einer Produktionsumgebung entfernen.