REST API Úvod a přihlášení
Požadavek
Požadavky je nutné posílat pomocí HTTPS. Všechny URL adresy začínají přidělenou adresou. V této dokumentaci budeme uvádět jako příklad: https://[VASE_SPOLECNOST].iquant.eu.
Pro zaslání vaší URL adresy kontaktujte prosím podporu Quantu.
Podporované formáty
API aktuálně podporuje formáty JSON a SVG dle typu požadavku.
Při použití jiného formátu dostanete ze serveru odpověď HTTP 415 Unsupported Media Type.
Ošetření chyb
V případě, že bude API dočasně nedostupné, bude chybová odpověď 5XX. Je zodpovědností klienta, aby v takovém případě požadavek vyzkoušel znovu.
Přihlášení
Pro komunikaci s API je potřeba přihlášení. V odpovědi na přihlášení obdržíte token, který budete používat pro další požadavky. Platnost tokenu je 30 minut. Po uplynutí platnosti je potřeba se znovu přihlásit o nový token.
Přihlásit se musíte pomocí uživatelské role Robot, kterého si vytvoříte v Quantu.
- REST Požadavek:
Parametr | Hodnota |
URL | /authenticate |
Header | Accept: application/json |
Header | Content-type: application/json |
Method | POST |
Payload | {"username":"<username>","password":"<password>"} |
- REST Odpověď:
Parametr | Hodnota |
Body | {"token":"<token>","status":"<result>"} |
V případě úspěšného přihlášení dostanete odpověď: HTTP 200. V odpovědi dostanete ověřovací token. V opačném případě bude v atributu status v odpovědi obsahovat chybovou hlášku, například:
HTTP 401 {"token":"","status":"Wrong username or password!"}"
Přihlášení do REST API
Požadavek
curl -H 'accept: application/json' -H 'content-type: application/json' "https://[VASE_SPOLECNOST].iquant.eu/authenticate" -d '{"username":"xxxx","password":"xxxx"}'
Odpověď
{"token":"nAti4s84yqxmgcOf16IOmp4NwLaJV7kJIoGFnzTDrra0JSEG02","status":"SUCCESS"}
Ověření
Ověření se provádí pomocí tokenu přiloženého do HTTP hlavičky.
Parametr | Hodnota |
Header | Authorization: Bearer <TOKEN> |
V případě, že je již token neplatný, dostanete odpověď:
HTTP 401 Unauthorized Content-Type: text/plain Body:"Token is missing or invalid!"
curl -H 'accept:application/svg+xml' -H 'Authorization: Bearer cDEHSUb03G8SJIAtHRYHYVeCmcxKxLDkVaUrhtBNGBSZpDyuBh' "https://[VASE_SPOLECNOST].iquant.eu/floorplan/55?productId=123456&kioskId=KID5&"