Přístupový kód

Aby mohla přístup k rozhraní JSON (JavaScript Object Notation) nebo k webovému uživatelskému rozhraní elektroměru KOSTAL Smart Energy Meter získat některá aplikace, musí se v elektroměru autorizovat.

Autorizace se provádí s použitím přístupového kódu, který byl předtím vygenerován v elektroměru KOSTAL Smart Energy Meter.

Vygenerování přístupového kódu

Přístupový kód lze vygenerovat u položky nabídky Profily > Přístupový kód.

Kliknutím na možnost PŘIDAT se otevře okno, ve kterém lze zadat jméno, roli a konec platnosti přístupového kódu.

Parametr

Vysvětlení

Název

Název uživatele, aplikace nebo přístroje, kteří mají rozhraní používat.

Role

  • api: Pomocí této funkce se lze dotazovat na naměřené údaje prostřednictvím rozhraní JSON.
  • admin: Pomocí této funkce se lze přihlašovat do webového rozhraní a provádět nastavení. Tento přístupový kód má veškerá oprávnění, která má i přihlášený uživatel.

Platnost končí

Konec platnosti přístupového kódu

Po vygenerování se přístupový kód zobrazí jednorázově. Nelze jej získat ani zobrazit znovu, a proto by měl být po obdržení zkopírován a bezpečně uložen.

Autorizace přístupového kódu

Nově vygenerovaný přístupový kód se musí autorizovat. Kliknutím na možnost AUTORIZOVAT se provede ověření přístupového kódu a jeho autorizace pro použití rozhraní JSON nebo webového rozhraní.

Smazání přístupového kódu

Přístupový kód lze ze systému vymazat kliknutím na možnost ODVOLAT.

 

Použití přístupového kódu API

Poté co je přístupový kód API ověřen a autorizován uživatelem, může jej aplikace použít pro dotazy prostřednictvím rozhraní JSON.

Přístupový kód se při tom přenáší jako součást hlavičky HTTP:

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

Použití přístupového kódu správce

Poté co je přístupový kód správce ověřen a autorizován uživatelem, může jej aplikace použít pro zobrazení webového rozhraní.

Přístupový kód se při tom přenáší jako součást hlavičky HTTP, resp. musí být uložen v lokální paměti prohlížeče, aby se z ní mohl načítat.

Přístupový kód TTL

Životnost přístupového kódu lze během žádosti o ověření omezit. Při tom se kromě názvu aplikace stanovuje i datum ukončení platnosti. Vydaný přístupový kód může navíc přihlášený uživatel odvolat prostřednictvím webového rozhraní. Všechny následné dotazy provedené pomocí odvolaného přístupového kódu poté budou zamítnuty.