Käyttöavain

Jotta sovellukselle voitaisiin myöntää pääsy JSON-rajapintaan (JavaScript Object Notation) tai KOSTAL Smart Energy Meter -energiamittarin verkkokäyttöliittymään, käyttäjän on auktorisoitava itsensä KOSTAL Smart Energy Meter -energiamittarille.

Auktorisointi tapahtuu tällöin käyttöavaimella, jonka KOSTAL Smart Energy Meter on luonut sitä ennen.

Käyttöavaimen luominen

Käyttöavaimet voidaan luoda valikkokohdassa Profile (profiilit) > Access tokens (käyttöavaimet).

Napsauttamalla kohtaa ADD (lisää) avautuu ikkuna, jossa voidaan määritellä käyttöavaimen nimi, rooli ja erääntymispäivä.

Parametri	Selitys
Name (nimi)	Nimet käyttäjälle, sovellukselle tai laitteelle, jota rajapinnan tulisi käyttää.
Role (rooli)	api: Tällä voidaan kysyä mittaustietoja JSON-rajapinnasta. admin: Tällä voidaan suorittaa sisäänkirjautumisia verkkopinnalle ja tehdä asetuksia. Tällä käyttöavaimella on kaikki oikeudet, jotka myös sisään kirjautuneella käyttäjällä on.
Expires on (viimeinen käyttöpäivä)	Käyttöavaimen viimeinen käyttöpäivä.

Luonnin jälkeen käyttöavain näytetään kertaluonteisesti. Sitä ei voi enää saada tai näyttää uudelleen ja siksi se tulisi saannin jälkeen kopioida ja tallentaa varmasti.

Käyttöavaimen valtuuttaminen

Uutena luotu käyttöavain on valtuutettava. Napsauttamalla kohtaa AUTHORISE (valtuuta) vahvistetaan käyttöavain ja valtuutetaan se JSON-rajapinnan tai verkon käyttöliittymän käyttöä varten.

Käyttöavaimen poistaminen

Käyttöavain voidaan poistaa järjestelmästä napsauttamalla kohtaa REVOKE (peruuta).

API-käyttöavaimen käyttö

Kun käyttäjä on vahvistanut ja valtuuttanut API-käyttöavaimen, sovellus voi käyttää sitä JSON-rajapintakyselyihin.

Sitä varten käyttöavain siirretään osana HTTP-otsikkoa:

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

Admin-käyttöavaimen käyttö

Kun käyttäjä on vahvistanut ja valtuuttanut Admin-käyttöavaimen, sovellus voi käyttää sitä verkon käyttöliittymien näyttöön.

Sitä varten käyttöavain siirretään osana HTTP-otsikkoa tai sen on oltava tallennettuna selaimen paikalliseen muistiin, jotta se voitaisiin lukea sieltä.

Käyttöavain TTL

Käyttöavaimen käyttöikä voidaan rajoittaa valtuutuskyselyn aikana. Tätä varten määritellään sovelluksen nimen lisäksi myös viimeinen käyttöpäivä. Lisäksi sisäänkirjautunut käyttäjä voi peruuttaa luodun käyttöavaimen verkkorajapinnan kautta. Kaikki peruutetun käyttöavaimen avulla suoritetut seuraavat kyselyt hylätään.