REST API
Zdroj Rest API umožňuje pripojiť kontrolér cien k ľubovoľnému systému, ktorý na zadaný kód vráti názov a cenu výrobku vo formáte JSON — napr. k internetovému obchodu, pokladničnému systému alebo vlastnej sprostredkovateľskej službe.
Ako to funguje
- (Voliteľne) Pri spustení aplikácie a po uložení nastavení si kontrolér cien vyzdvihne token z adresy tokenu.
- Po každom naskenovaní odošle požiadavku na adresu údajov, v ktorej sa
{code}nahradí naskenovaným kódom. Ak má token, pridá hlavičkuAuthorization: Bearer <token>. - Z odpovede JSON prečíta názov, cenu a voliteľne EAN — podľa ciest, ktoré zadáte.
Funguje http:// aj https://. Aplikácia čaká na odpoveď približne 10 sekúnd.
Polia
Token (voliteľný) — ak API overovanie nevyžaduje, nechajte Url to token prázdne.
| Pole | Čo zadať | Príklad |
|---|---|---|
| Url to token | Adresa, ktorá vracia token. | https://api.example.com/auth |
| GET / POST | Metóda požiadavky na token. | POST |
| Body request | Telo JSON odosielané s POST (pole je viditeľné len pri POST). | {"user":"pricechecker","password":"…"} |
| Path to token | Kde je token v odpovedi JSON. | token alebo $.data.token |
Údaje výrobku
| Pole | Čo zadať | Príklad |
|---|---|---|
| Url to data | Adresa požiadavky na výrobok; {code} sa nahradí naskenovaným kódom. | https://api.example.com/price?code={code} |
| GET / POST | Metóda požiadavky na výrobok. | GET |
| Body request | Telo JSON pre POST; aj tu môžete použiť {code}. | {"ean":"{code}"} |
| Path to name | Cesta k názvu výrobku v odpovedi. | product.name |
| Path to price | Cesta k cene; hodnota musí byť číslo. | product.price |
| Path to EAN (optional) | Cesta ku kódu EAN zobrazenému pod cenou. Prázdne = pod cenou sa zobrazí naskenovaný kód. | product.ean |
Cesty používajú syntax JsonPath: product.name a $.product.name znamenajú to isté, prvok poľa je napr. $.items[0].price. Požiadavky POST sa odosielajú s hlavičkou Content-Type: application/json; charset=utf-8.
Príklad
Požiadavka po naskenovaní kódu 5901234567890:
GET https://api.example.com/price?code=5901234567890
Authorization: Bearer eyJhbGciOi...
Odpoveď, ktorej kontrolér cien rozumie:
{
"product": {
"name": "Coffee beans 1 kg",
"price": 59.99,
"ean": "5901234567890"
}
}
Nastavenie: Path to name product.name, Path to price product.price, Path to EAN product.ean. Cenu vracajte ako číslo s desatinnou bodkou — kontrolér cien ju naformátuje podľa poľa Price format.
Požiadavky na API
- Pre nájdený výrobok API odpovedá stavom 2xx a JSON obsahujúcim názov a cenu.
- Akákoľvek iná odpoveď (napr. 404 pre neznámy kód, 401 pre neplatný token, chýbajúce pole v JSON) zobrazí na obrazovke Data download error. Pri REST API aplikácia nezobrazuje „Product not found“ — ak chcete, aby zákazníci tieto prípady rozlíšili, vracajte napr. názov „Product not available“ s cenou 0.
- Kód sa do URL vkladá bez kódovania. Kódy EAN a bežné symboly ťažkosti nerobia; ak vaše symboly obsahujú medzery alebo špeciálne znaky, použite požiadavku POST s kódom v tele.
- Token sa vyzdvihuje len pri spustení aplikácie a po uložení nastavení — aplikácia ho sama neobnovuje. Použite dlhodobý token alebo kľúč, ktorý nevyprší; po vypršaní tokenu pomôže reštart aplikácie.
Connection test v nastaveniach kontroluje iba požiadavku na token. Ak je adresa tokenu prázdna, test vždy uspeje — skutočnou kontrolou je naskenovanie niekoľkých výrobkov po uložení nastavení.