REST API
Zdroj Rest API umožňuje připojit ověřovač cen k libovolnému systému, který na zadaný kód vrátí název a cenu výrobku ve formátu JSON — např. k internetovému obchodu, pokladnímu systému nebo vlastní zprostředkující službě.
Jak to funguje
- (Volitelně) Při spuštění aplikace a po uložení nastavení si ověřovač cen vyzvedne token z adresy tokenu.
- Po každém naskenování odešle požadavek na adresu dat, ve které se
{code}nahradí naskenovaným kódem. Pokud má token, přidá hlavičkuAuthorization: Bearer <token>. - Z odpovědi JSON přečte název, cenu a volitelně EAN — podle cest, které zadáte.
Funguje http:// i https://. Aplikace čeká na odpověď zhruba 10 sekund.
Pole
Token (volitelný) — pokud API ověřování nevyžaduje, nechte Url to token prázdné.
| Pole | Co zadat | Příklad |
|---|---|---|
| Url to token | Adresa, která vrací token. | https://api.example.com/auth |
| GET / POST | Metoda požadavku na token. | POST |
| Body request | Tělo JSON odesílané s POST (pole je viditelné jen u POST). | {"user":"pricechecker","password":"…"} |
| Path to token | Kde je token v odpovědi JSON. | token nebo $.data.token |
Data výrobku
| Pole | Co zadat | Příklad |
|---|---|---|
| Url to data | Adresa požadavku na výrobek; {code} se nahradí naskenovaným kódem. | https://api.example.com/price?code={code} |
| GET / POST | Metoda požadavku na výrobek. | GET |
| Body request | Tělo JSON pro POST; i zde můžete použít {code}. | {"ean":"{code}"} |
| Path to name | Cesta k názvu výrobku v odpovědi. | product.name |
| Path to price | Cesta k ceně; hodnota musí být číslo. | product.price |
| Path to EAN (optional) | Cesta ke kódu EAN zobrazenému pod cenou. Prázdné = pod cenou se zobrazí naskenovaný kód. | product.ean |
Cesty používají syntaxi JsonPath: product.name a $.product.name znamenají totéž, prvek pole je např. $.items[0].price. Požadavky POST se odesílají s hlavičkou Content-Type: application/json; charset=utf-8.
Příklad
Požadavek po naskenování kódu 5901234567890:
GET https://api.example.com/price?code=5901234567890
Authorization: Bearer eyJhbGciOi...
Odpověď, které ověřovač cen rozumí:
{
"product": {
"name": "Coffee beans 1 kg",
"price": 59.99,
"ean": "5901234567890"
}
}
Nastavení: Path to name product.name, Path to price product.price, Path to EAN product.ean. Cenu vracejte jako číslo s desetinnou tečkou — ověřovač cen ji naformátuje podle pole Price format.
Požadavky na API
- Pro nalezený výrobek API odpovídá stavem 2xx a JSON obsahujícím název a cenu.
- Jakákoli jiná odpověď (např. 404 pro neznámý kód, 401 pro neplatný token, chybějící pole v JSON) zobrazí na obrazovce Data download error. U REST API aplikace nezobrazuje „Product not found“ — pokud chcete, aby zákazníci tyto případy rozlišili, vracejte např. název „Product not available“ s cenou 0.
- Kód se do URL vkládá bez kódování. Kódy EAN a běžné symboly potíže nedělají; pokud vaše symboly obsahují mezery nebo speciální znaky, použijte požadavek POST s kódem v těle.
- Token se vyzvedává jen při spuštění aplikace a po uložení nastavení — aplikace ho sama neobnovuje. Použijte dlouhodobý token nebo klíč, který nevyprší; po vypršení tokenu pomůže restart aplikace.
Connection test v nastavení kontroluje pouze požadavek na token. Pokud je adresa tokenu prázdná, test vždy uspěje — skutečnou kontrolou je naskenování několika výrobků po uložení nastavení.