Access tokens (Adgangstokens)

Hvis en applikation skal have adgang til JSON-interfacet (JavaScript Object Notation) eller web-user-interfacet for KOSTAL Smart Energy Meter, skal den autorisere sig over for KOSTAL Smart Energy Meter.

Autoriseringen sker via en adgangstoken, der forinden er blevet oprettet i KOSTAL Smart Energy Meter.

Oprettelse af adgangstoken

Adgangstokens kan oprettes under menupunktet Profile (Profil) > Access tokens (Adgangstokens).

Ved klik på ADD (TILFØJ) åbner et vindue, hvor navn, rolle og udløbsdato for en adgangstoken kan fastsættes.

Parameter

Forklaring

Navn

Navn på brugeren, applikationen eller apparatet, som skal anvende interfacet.

Rolle

  • api: Hermed kan måledata forespørges via JSON-interfacet.
  • admin: Hermed kan der logges på ved web-fladen, og der kan foretages indstillinger. Denne adgangstoken har alle rettigheder, som en bruger, der er logget på, også har.

Udløber den

Udløbsdato for adgangstoken.

Efter oprettelsen vises din adgangstoken én gang. Det er ikke muligt at få den igen eller få den vist igen, og den bør derfor kopieres og gemmes et sikkert sted efter modtagelsen.

Autorisering af adgangstoken

En nyoprettet adgangstoken skal autoriseres. Ved klik på AUTHORIZE (AUTORISER) godkendes en adgangstoken og autoriseres til anvendelsen af JSON-interfacet eller web-user-interfacet.

Sletning af en adgangstoken

En adgangstoken kan slettes fra systemet ved at klikke på REVOKE (TILBAGEKALD).

 

Anvendelse af API-adgangstoken

Når en API-adgangstoken er blevet godkendt og autoriseret af brugeren, kan denne via applikationen anvendes til JSON-interface-forespørgsler.

Hertil overføres denne adgangstoken, som del af HTTP-headeren:

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

Anvendelse af Admin-adgangstoken

Når en Admin-adgangstoken er blevet godkendt og autoriseret af brugeren, kan denne via applikationen anvendes til visning af web-user-interfacet.

Hertil overføres denne adgangstoken, som del af HTTP-headeren eller skal være gemt i browserens lokale lager, så den kan udlæses herfra.

Adgangstoken TTL

Levetiden for en adgangstoken kan begrænses under godkendelsesforespørgslen. Til dette formål defineres der ud over et navn for applikationen også en udløbsdato. Derudover kan en oprettet adgangstoken trækkes tilbage via web-fladen af en bruger, der er logget på. Alle efterfølgende forespørgsler, der sker vha. en tilbagetrukket adgangstoken, afvises.