Clés d’accès

Pour permettre à une application d'accéder à l'interface JSON (JavaScript Object Notation) ou à l'interface utilisateur Web du KOSTAL Smart Energy Meter, celle-ci doit s'autoriser auprès du KOSTAL Smart Energy Meter.

L'autorisation se fait par le biais d'une clé d'accès générée au préalable dans le KOSTAL Smart Energy Meter.

Création de la clé d'accès

Les clés d'accès peuvent être générées sous l'option de menu Profils > Clés d'accès.

En cliquant sur AJOUTER, une fenêtre s'ouvre dans laquelle on peut définir le nom, le rôle et la date d'expiration de la clé d'accès.

Paramètre	Explication
Nom	Nom de l'utilisateur, de l'application ou de l'appareil qui doit utiliser l'interface.
Rôle	api : permet d'interroger les données de mesure via l'interface JSON. admin : permet de se connecter à l'interface web et d'effectuer des réglages. Cette clé d'accès a tous les droits qu'un utilisateur connecté a également.
Expire le	Date d'expiration de la clé d'accès.

Une fois créée, la clé d'accès s'affiche une seule fois. Elle ne peut pas être reçue ou affichée à nouveau, et doit donc être copiée et sauvegardée en toute sécurité dès sa réception.

Autorisation de la clé d'accès

Une clé d'accès nouvellement émise doit être autorisée. En cliquant sur AUTORISER, une clé d'accès est authentifiée et autorisée pour l'utilisation de l'interface JSON ou de l'interface utilisateur web.

Suppression de la clé d'accès

Une clé d'accès peut être supprimée du système en cliquant sur RÉVOQUER.

Utilisation de la clé d'accès API

Une fois qu'une clé d'accès API a été authentifiée et autorisée par l'utilisateur, elle peut être utilisée par l'application pour les requêtes d'interface JSON.

Pour ce faire, la clé d'accès est transmise comme partie de l'en-tête HTTP :

GET /api/json/<resource>HTTP/1.1
Hôte : <energy manager>
Type de contenu : application/json
Autorisation : Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9[...]

Utilisation de la clé d'accès Admin

Une fois qu'une clé d'accès Admin a été authentifiée et autorisée par l'utilisateur, elle peut être utilisée par l'application pour afficher l'interface utilisateur web.

Pour cela, la clé d'accès est transmise comme partie de l'en-tête HTTP ou doit être déposée dans la mémoire locale du navigateur pour pouvoir être lue depuis la mémoire.

Clé d'accès TTL

La durée de vie d'une clé d'accès peut être limitée pendant la demande d'authentification. Pour ce faire, une date d'expiration est définie en plus du nom de l'application. En outre, une clé d'accès émise peut être retirée par un utilisateur connecté via l'interface Web. Toutes les demandes ultérieures effectuées à l'aide d'une clé d'accès retirée seront refusées.