Chaves de acesso

Para conceder a uma aplicação o acesso à interface JSON (JavaScript Object Notation) ou à interface do utilizador Web do KOSTAL Smart Energy Meter, esta deve receber autorização do KOSTAL Smart Energy Meter.

A autorização é concedida através de uma chave de acesso que foi previamente gerada no KOSTAL Smart Energy Meter.

Criação da chave de acesso

As chaves de acesso podem ser criadas no item de menu Perfil > Chaves de acesso.

Ao clicar em ADICIONAR, abre-se uma janela na qual o nome, a função e a data de expiração da chave de acesso podem ser especificados.

Parâmetros	Descrição
Nome	Nome do utilizador, aplicação ou aparelho que deve utilizar a interface.
Função	api: permite consultar os dados de medição através da interface JSON. admin: permite iniciar sessão na interface Web e efetuar configurações. Esta chave de acesso tem os mesmos direitos que um utilizador com sessão iniciada.
Expira a	Data de expiração da chave de acesso.

Após a criação, a chave de acesso é apresentada uma única vez. Não pode ser recebida ou apresentada novamente e deve, portanto, ser copiada e armazenada em segurança após a sua receção.

Autorização da chave de acesso

Uma nova chave de acesso emitida tem de ser autorizada. Ao clicar em AUTORIZAR, é autenticada e autorizada uma chave de acesso para a utilização da interface JSON ou da interface do utilizador Web.

Eliminação da chave de acesso

Uma chave de acesso pode ser eliminada do sistema ao clicar em REVOGAR.

Utilização da chave de acesso API

Uma vez autenticada e autorizada pelo utilizador uma chave de acesso API, esta pode ser utilizada pela aplicação para pedidos da interface JSON.

Para este efeito, a chave de acesso é transmitida como parte do cabeçalho HTTP:

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

Utilização da chave de acesso Admin

Uma vez autenticada e autorizada pelo utilizador uma chave de acesso Admin, esta pode ser utilizada pela aplicação para apresentar a interface do utilizador Web.

Para este fim, a chave de acesso é transmitida como parte do cabeçalho HTTP ou deve ser armazenada na memória local do navegador para poder ser lida a partir daí.

Chave de acesso TTL

A vida útil de uma chave de acesso pode ser limitada durante o pedido de autenticação. Para este efeito, é definida uma data de expiração, para além do nome da aplicação. Além disso, uma chave de acesso emitida pode ser cancelada por um utilizador com sessão iniciada através da interface Web. Todos os pedidos subsequentes efetuados através de uma chave de acesso cancelada serão rejeitados.