Ключ за достъп

За да се предостави на дадено приложение достъп до JSON интерфейса (JavaScript Object Notation) или уеб интерфейса на KOSTAL Smart Energy Meter, то трябва да се авторизира пред KOSTAL Smart Energy Meter.

Удостоверяването се извършва чрез ключ за достъп, който е бил предварително генериран в KOSTAL Smart Energy Meter.

Създаване на ключ за достъп

Ключовете за достъп могат да бъдат създадени в менюто Профили > Ключ за достъп.

С кликване върху ДОБАВИ се отваря прозорец, в който могат да се зададат името, ролята и датата на изтичане на ключа за достъп.

Параметри

Обяснение

Име

Име на потребителя, приложението или устройството, което ще използва интерфейса.

Роля

  • api: С него могат да се извличат измервателни данни чрез JSON интерфейса.
  • admin: С него можете да влизате в уеб интерфейса и да извършвате настройки. Този ключ за достъп има всички права, които има и вписаният потребител.

Изтича на

Дата на изтичане на ключа за достъп.

След създаването му ключът за достъп се показва еднократно. Той не може да бъде получен или показан отново и затова трябва да бъде копиран и съхранен на сигурно място след получаването му.

Упълномощаване на ключа за достъп

Новоиздаден ключ за достъп трябва да бъде оторизиран. С натискане на ОТОРИЗИРАЙ ключът за достъп се удостоверява и оторизира за използване на JSON интерфейса или уеб потребителския интерфейс.

Изтриване на ключа за достъп

Достъпният ключ може да бъде изтрит от системата, като кликнете върху ОТМЕНА.

 

Използване на API ключа за достъп

След като ключът за достъп до API бъде удостоверен и оторизиран от потребителя, той може да бъде използван от приложението за заявки към JSON интерфейса.

За целта ключът за достъп се предава като част от HTTP-заглавката:

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

Използване на ключ за достъп на администратора

След като ключът за достъп на администратора бъде удостоверен и оторизиран от потребителя, той може да бъде използван от приложението за показване на уеб интерфейса на потребителя.

За целта ключът за достъп се предава като част от HTTP заглавката или трябва да бъде съхранен в локалната памет на браузъра, за да може да бъде прочетен оттам.

Ключ за достъп TTL

Срокът на валидност на ключа за достъп може да бъде ограничен по време на заявката за удостоверяване. За целта се определя дата на изтичане на валидността в допълнение към името на приложението. Освен това издаден ключ за достъп може да бъде оттеглен от регистриран потребител чрез уеб интерфейса. Всички последващи заявки, които се правят с помощта на оттеглен ключ за достъп, се отхвърлят.