Zugriffsschlüssel

Um einer Anwendung den Zugriff auf die JSON-Schnittstelle (JavaScript Object Notation) oder das Web-User-Interface des KOSTAL Smart Energy Meters zu gewähren, muss sich diese gegenüber dem KOSTAL Smart Energy Meter autorisieren.

Die Autorisierung erfolgt dabei über einen Zugriffsschlüssel, welcher zuvor im KOSTAL Smart Energy Meter erzeugt wurde.

Erstellen des Zugriffsschlüssels

Zugriffsschlüssel können unter dem Menüpunkt Profile > Zugriffsschlüssel erzeugt werden.

Durch einen Klick auf HINZUFÜGEN öffnet sich ein Fenster, in dem Name, Rolle und Ablaufdatum des Zugriffsschlüssels festgelegt werden können.

Parameter	Erklärung
Name	Namen des Benutzers, der Anwendung oder des Geräts, welches die Schnittstelle verwenden soll.
Rolle	api: Hiermit können Messdaten über die JSON-Schnittstelle abgefragt werden. admin: Hiermit können Logins an der Web-Oberfläche erfolgen und Einstellungen getätigt werden. Dieser Zugriffsschlüssel hat alle Rechte, die ein eingeloggter Benutzer auch hat.
Erlischt am	Ablaufdatum des Zugriffsschlüssels.

Nach dem Erstellen wird der Zugriffsschlüssel einmalig angezeigt. Er kann nicht noch einmal erhalten oder angezeigt werden und sollte daher nach Erhalt kopiert und sicher abgespeichert werden.

Autorisierung des Zugriffsschlüssels

Ein neu ausgestellter Zugriffsschlüssel muss autorisiert werden. Durch Klick auf AUTORISIEREN wird ein Zugriffsschlüssel authentifiziert und für die Nutzung der JSON-Schnittstelle bzw. des Web-User-Interface autorisiert.

Löschen des Zugriffsschlüssels

Ein Zugriffsschlüssel kann durch Klick auf WIDERRUFEN aus dem System gelöscht werden.

Verwendung des API-Zugriffsschlüssels

Nachdem ein API-Zugriffsschlüssel durch den Benutzer authentifiziert und autorisiert wurde, kann dieser durch die Anwendung für JSON-Schnittstellen-Anfragen verwendet werden.

Dazu wird der Zugriffsschlüssel als Teil des HTTP-Headers übertragen:

GET /api/json/<resource> HTTP/1.1
Host: <energy manager>
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9[..]

Verwendung des Admin-Zugriffsschlüssels

Nachdem ein Admin-Zugriffsschlüssel durch den Benutzer authentifiziert und autorisiert wurde, kann dieser durch die Anwendung für die Anzeige des Web-User-Interfaces verwendet werden.

Dazu wird der Zugriffsschlüssel als Teil des HTTP-Headers übertragen bzw. muss im lokalen Speicher des Browsers hinterlegt sein, um von dort ausgelesen zu werden.

Zugriffsschlüssel TTL

Die Lebenszeit eines Zugriffsschlüssels kann während der Authentifizierungsanfrage begrenzt werden. Hierzu wird zusätzlich zum Namen der Anwendung ein Ablaufdatum definiert. Des Weiteren kann ein ausgestellter Zugriffsschlüssel durch einen angemeldeten Benutzer über die Weboberfläche zurückgezogen werden. Alle nachfolgenden Anfragen, die mit Hilfe eines zurückgezogenen Zugriffsschlüssels erfolgen, werden abgelehnt.