Klucze dostępu

W celu udzielenia aplikacji dostępu do interfejsu JSON (JavaScript Object Notation) lub webowego interfejsu użytkownika licznika KOSTAL Smart Energy Meter, musi ona dokonać autoryzacji w liczniku KOSTAL Smart Energy Meter.

Autoryzacja odbywa się za pośrednictwem klucza dostępu, który został wcześniej wygenerowany w liczniku KOSTAL Smart Energy Meter.

Tworzenie klucza dostępu

Klucze dostępu można wygenerować w punkcie menu Profile > Klucze dostępu.

Po kliknięciu DODAJ otwarte zostanie okno, w którym można określić nazwę, rolę i datę ważności klucza dostępu.

Parametr	Objaśnienie
Nazwa	Nazwa użytkownika, aplikacji lub urządzenia, które ma korzystać z interfejsu.
Rola	api: W tym przypadku dane pomiarowe mogą być odpytywane za pośrednictwem interfejsu JSON. admin: Użycie w celu zalogowania się do interfejsu internetowego i wprowadzenia ustawień. Ten klucz dostępu jest wyposażony we wszystkie prawa zalogowanego użytkownika.
Wygasa dnia	Data upływu ważności klucza dostępu.

Po utworzeniu klucz dostępu jest wyświetlany jednokrotnie. Nie można go otrzymać ani wyświetlić ponownie, dlatego po otrzymaniu należy go skopiować i przechowywać w bezpieczny sposób.

Autoryzacja klucza dostępu

Nowo wydany klucz dostępu musi zostać poddany autoryzacji. Po kliknięciu AUTORYZUJ klucz dostępu zostaje uwierzytelniony i autoryzowany do korzystania z interfejsu JSON lub webowego interfejsu użytkownika.

Usuwanie klucza dostępu

Klucz dostępu można usunąć z systemu, klikając ODWOŁAJ.

Korzystanie z klucza dostępu do API

Po uwierzytelnieniu i autoryzacji klucza dostępu do interfejsu API przez użytkownika, może on być wykorzystywany przez aplikację do żądań interfejsu JSON.

W tym celu klucz dostępu jest przekazywany jako element nagłówka HTTP:

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

Korzystanie z klucza dostępu administratora

Po uwierzytelnieniu i autoryzacji klucza dostępu administratora przez użytkownika może on zostać wykorzystany przez aplikację do wyświetlenia webowego interfejsu użytkownika.

W tym celu klucz dostępu jest przekazywany jako element nagłówka HTTP lub musi być przechowywany w pamięci lokalnej przeglądarki, aby można było go stamtąd odczytać.

Klucz dostępu TTL

Czas życia klucza dostępu może zostać ograniczony podczas żądania uwierzytelnienia. W tym celu oprócz nazwy aplikacji definiowana jest data upływu ważności. Ponadto wydany klucz dostępu może zostać odebrany przez zalogowanego użytkownika za pośrednictwem interfejsu internetowego. Wszystkie kolejne żądania wykonane przy użyciu wycofanego klucza dostępu zostaną odrzucone.