10 / 48
The reproduction, distribution and utilization of this document as well as the communication of its contents to others without
express authorization is prohibited. Offenders will be held liable for the payment of damages.
All rights reserved in the event of the grant of patent, utility model or design.
14.04.2020
Version 1.18.0
Authorisation
REST
3 Authorisation
Authorisation is performed via JWT tokens. Username and password are required to receive the initial token. A token is
valid for 1 hour.
3.1
Token information
Part
Content
Comment
HEADER
"typ": "JWT",
"alg": "HS256"
Token type → JsonWebToken
Signature type → HMAC-SHA256
PAYLOAD
"iat": 1492765233,
"exp": 1492768833,
"nbf": 1492765233,
"identity": 2
Time of creation
Valid until
Valid from
User (2→ user-role-edit)
VERIFY SIGNATURE
HMACSHA256( base64UrlEncod
e(header) + "." +
base64UrlEncode(payload),
secretKey )
3.2
Auth
Name
auth
URL
https://[deviceIP]:[restPort]/auth
Availability
APS-RS firmware 1.10
Method
Data
Result
HTTP Status
Comments
GET
—
not supported
405 - Method Not Allowed
POST
User / Passwort
Token in JWT format
200 - OK on success
400 - Bad Request on internal
error → additional information in
JSON error payload
PUT
—
not supported
405 - Method Not Allowed