Clave de acceso

Para garantizar el acceso de una aplicación a la interfaz JSON (JavaScript Object Notation) o a la interfaz de usuario web del KOSTAL Smart Energy Meter, esta debe autorizarse frente al KOSTAL Smart Energy Meter.

La autorización tiene lugar a través de una clave de acceso que se ha generado previamente en el KOSTAL Smart Energy Meter.

Creación de la clave de acceso

Las claves de acceso pueden crearse en la opción de menú Perfiles > Claves de acceso .

Al hacer clic en AÑADIR se abre una ventana en la que se puede especificar el nombre, el rol y la fecha de caducidad de la clave de acceso.

Parámetro

Aclaración

Nombre

Nombre de usuario, de la aplicación o del equipo que va a utilizar la interfaz.

Rol

  • api: Con esto, los datos de medición pueden consultarse a través de la interfaz JSON.
  • admin: Se puede utilizar para inicios de sesión en la interfaz web y para la configuración. Esta clave de acceso tiene todos los derechos que también tiene un usuario que ha iniciado sesión.

Vence el

Fecha de caducidad de la clave de acceso.

Después de la creación, la clave de acceso se muestra una vez. No puede recibirse ni mostrarse de nuevo, por lo que debe copiarse y guardarse de forma segura en cuanto se reciba.

Autorización de la clave de acceso

Se debe autorizar una clave de acceso recién emitida. Al hacer clic en AUTORIZAR , una clave de acceso es autenticada y autorizada para el uso de la interfaz JSON o la interfaz de usuario web.

Eliminación de la clave de acceso

Una clave de acceso puede ser eliminada del sistema haciendo clic en REVOCAR .

 

Uso de la clave de acceso API

Una vez que una clave de acceso API ha sido autenticada y autorizada por el usuario, puede ser utilizada por la aplicación para las solicitudes de la interfaz JSON.

Para ello, la clave de acceso se transmite como parte de la cabecera HTTP:

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

Uso de la clave de acceso Admin

Una vez que una clave de acceso Admin ha sido autenticada y autorizada por el usuario, puede ser utilizada por la aplicación para mostrar la interfaz de usuario web.

Para ello, la clave de acceso se transmite como parte de la cabecera HTTP o debe almacenarse en la memoria local del navegador para poder ser leída desde allí.

Clave de acceso TTL

La duración de una clave de acceso puede limitarse durante la solicitud de autenticación. Para ello, se define una fecha de caducidad además del nombre de la aplicación. Además, una clave de acceso emitida puede ser retirada por un usuario que ha iniciado sesión a través de la interfaz web. Todas las solicitudes posteriores realizadas con una clave de acceso retirada se rechazan.