Chiave di accesso

Per poter accedere all’interfaccia JSON (JavaScript Object Notation) o all’interfaccia utente web del KOSTAL Smart Energy Meter, un’applicazione deve autorizzarsi nei confronti del KOSTAL Smart Energy Meter.

L’autorizzazione viene concessa tramite una chiave di accesso precedentemente generata nel KOSTAL Smart Energy Meter.

Creazione della chiave di accesso

Le chiavi di accesso possono essere create alla voce di menu Profili > Chiave di accesso.

Facendo clic su AGGIUNGI si apre una finestra in cui è possibile specificare il nome, il ruolo e la data di scadenza della chiave di accesso.

Parametro

Spiegazione

Nome

Nome dell’utente, dell’applicazione o del dispositivo che deve utilizzare l’interfaccia.

Ruolo

  • api: può essere utilizzato per interrogare i dati di misura tramite l’interfaccia JSON.
  • admin: può essere utilizzato per accedere all’interfaccia web ed effettuare le impostazioni. Questa chiave di accesso ha tutti i diritti di cui dispone anche un utente connesso.

Decade il

Data di scadenza della chiave di accesso.

Dopo la creazione, la chiave di accesso viene visualizzata una volta. Non è possibile riceverla o visualizzarla di nuovo e pertanto deve essere copiata e conservata in modo sicuro al momento della ricezione.

Autorizzazione della chiave di accesso

Una chiave di accesso nuova deve essere autorizzata. Facendo clic su AUTORIZZA, una chiave di accesso viene autenticata e autorizzata per l’uso dell’interfaccia JSON o dell’interfaccia utente web.

Eliminazione della chiave di accesso

Una chiave di accesso può essere eliminata dal sistema facendo clic su REVOCA.

 

Utilizzo della chiave di accesso API

Una volta che una chiave di accesso API è stata autenticata e autorizzata dall’utente, può essere utilizzata dall’applicazione per le richieste dell’interfaccia JSON.

A tal fine, la chiave di accesso viene trasmessa come parte dell’intestazione HTTP:

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

Utilizzo della chiave di accesso amministratore

Una volta che una chiave di accesso amministratore è stata autenticata e autorizzata dall’utente, può essere utilizzata dall’applicazione per visualizzare l’interfaccia utente web.

A tal fine, la chiave di accesso viene trasmessa come parte dell’intestazione HTTP e/o deve essere memorizzata nella memoria locale del browser per poter essere letta.

Chiave di accesso TTL

La durata di una chiave di accesso può essere limitata durante la richiesta di autenticazione. A tal fine, oltre al nome dell’applicazione, viene definita una data di scadenza. Inoltre, una chiave di accesso rilasciata può essere ritirata da un utente registrato tramite l’interfaccia web. Tutte le richieste successive effettuate utilizzando una chiave di accesso ritirata vengono respinte.