Åtkomsttoken

För att ge en applikation åtkomst till JSON-gränssnittet (JavaScript Object Notation) eller webbgränssnittet för KOSTAL Smart Energy Meter måste denna auktoriseras gentemot KOSTAL Smart Energy Meter.

Auktoriseringen sker via en åtkomsttoken som dessförinnan har skapats i KOSTAL Smart Energy Meter.

Skapa åtkomsttoken

Åtkomsttoken kan skapas under menyalternativet Profiles (Profiler) > Access tokens (Åtkomsttoken) .

Om du klickar på ADD (Lägg till) öppnas ett fönster där du kan ange namn, roll och utgångsdatum för åtkomsttoken.

Parameter

Förklaring

Namn

Namnet på den användare, den applikation eller den enhet som ska använda gränssnittet.

Roll

  • api: Används för att läsa av mätdata via JSON-gränssnittet.
  • admin: Används för att logga in i webbgränssnittet och göra inställningar. Denna åtkomsttoken har alla rättigheter som en inloggad användare också har.

Går ut den

Datum då giltighetstiden för åtkomsttoken går ut.

Åtkomsttoken visas en gång efter att den har skapats. Den kan inte erhållas eller visas ännu en gång och bör därför kopieras och förvaras säkert efter mottagandet.

Auktorisering av åtkomsttoken

En ny åtkomsttoken som har utfärdats måste auktoriseras. Genom att klicka på AUTHORISE (Auktorisera) autentiseras en åtkomsttoken och auktoriseras för användning av JSON-gränssnittet eller webbgränssnittet.

Radera åtkomsttoken

En åtkomsttoken kan tas bort från systemet genom att klicka på REVOKE (Ångra).

 

Användning av API-åtkomsttoken

När en API-åtkomsttoken har autentiserats och auktoriserats av användaren kan den användas av applikationen för förfrågningar via JSON-gränssnittet.

För detta ändamål överförs åtkomsttoken som en del av HTTP-headern:

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

Använda Admin-åtkomsttoken

När användaren har autentiserat och auktoriserat en admin-åtkomsttoken, kan den användas av applikationen för att visa webbgränssnittet.

För detta ändamål överförs åtkomsttoken som en del av HTTP-headern eller måste vara inlagd i webbläsarens lokala minne för att kunna läsas därifrån.

Åtkomsttoken TTL

Livstiden för en åtkomsttoken kan begränsas under autentiseringsbegäran. För detta ändamål definieras ett utgångsdatum utöver applikationens namn. Dessutom kan en utställd åtkomsttoken återkallas av en annan inloggad användare via webbgränssnittet. Alla efterföljande förfrågningar som görs med en återkallad åtkomsttoken kommer att avvisas.