Přeskočit na hlavní obsah

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​

  1. (Volitelně) Při spuštění aplikace a po uložení nastavení si ověřovač cen vyzvedne token z adresy tokenu.
  2. 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čku Authorization: Bearer <token>.
  3. 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é.

PoleCo zadatPříklad
Url to tokenAdresa, která vrací token.https://api.example.com/auth
GET / POSTMetoda požadavku na token.POST
Body requestTělo JSON odesílané s POST (pole je viditelné jen u POST).{"user":"pricechecker","password":"…"}
Path to tokenKde je token v odpovědi JSON.token nebo $.data.token

Data výrobku

PoleCo zadatPříklad
Url to dataAdresa požadavku na výrobek; {code} se nahradí naskenovaným kódem.https://api.example.com/price?code={code}
GET / POSTMetoda požadavku na výrobek.GET
Body requestTělo JSON pro POST; i zde můžete použít {code}.{"ean":"{code}"}
Path to nameCesta k názvu výrobku v odpovědi.product.name
Path to priceCesta 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í.

REST API — FAQ

Jak připojím ověřovač cen HDWR k vlastnímu systému?
Zvolte zdroj Rest API a zadejte adresu požadavku na výrobek se zástupným znakem {code} na místě kódu, např. https://api.example.com/price?code={code}, a také cesty k názvu a ceně v odpovědi JSON. Volitelně zadejte adresu, ze které aplikace vyzvedne token Bearer.
Proč ověřovač cen u REST API zobrazuje Data download error místo Product not found?
U REST API se každá odpověď jiná než 2xx, nebo odpověď bez pole s názvem či cenou, považuje za chybu. Pokud API pro neznámý kód vrací 404, zobrazí obrazovka Data download error.
Obnovuje aplikace token REST API?
Ne. Token se vyzvedává při spuštění aplikace a po uložení nastavení. Použijte dlouhodobý token; po jeho vypršení aplikaci restartujte.
Podporuje ověřovač cen obyčejné HTTP?
Ano, podporuje http i https. V místní síti prodejny můžete použít http; pro API na internetu použijte https.