Skip to main content

REST API

Šaltinis Rest API leidžia prijungti kainų tikrintuvą prie bet kurios sistemos, kuri pagal pateiktą kodą grąžina prekės pavadinimą ir kainą JSON formatu — pvz., internetinės parduotuvės, kasos sistemos ar savo tarpinės paslaugos.

Kaip tai veikia​

  1. (Pasirinktinai) Paleidus programėlę ir išsaugojus nustatymus, kainų tikrintuvas iš žetono adreso gauna žetoną.
  2. Po kiekvieno nuskaitymo jis išsiunčia užklausą duomenų adresu, kuriame {code} pakeičiamas nuskaitytu kodu. Jei turi žetoną, prideda antraštę Authorization: Bearer <token>.
  3. Iš JSON atsako jis perskaito pavadinimą, kainą ir, jei reikia, EAN — pagal jūsų nurodytus kelius.

Veikia ir http://, ir https://. Programėlė laukia atsakymo apie 10 sekundžių.

Laukai​

Žetonas (neprivalomas) — jei API autentifikavimo nereikalauja, lauką Url to token palikite tuščią.

LaukasKą įvestiPavyzdys
Url to tokenAdresas, kuris grąžina žetoną.https://api.example.com/auth
GET / POSTŽetono užklausos metodas.POST
Body requestJSON turinys, siunčiamas su POST (laukas matomas tik esant POST).{"user":"pricechecker","password":"…"}
Path to tokenKur JSON atsake yra žetonas.token arba $.data.token

Prekės duomenys

LaukasKą įvestiPavyzdys
Url to dataPrekės užklausos adresas; {code} pakeičiamas nuskaitytu kodu.https://api.example.com/price?code={code}
GET / POSTPrekės užklausos metodas.GET
Body requestJSON turinys POST užklausai; čia taip pat galite naudoti {code}.{"ean":"{code}"}
Path to nameKelias iki prekės pavadinimo atsake.product.name
Path to priceKelias iki kainos; reikšmė turi būti skaičius.product.price
Path to EAN (optional)Kelias iki po kaina rodomo EAN kodo. Tuščias = po kaina rodomas nuskaitytas kodas.product.ean

Keliai naudoja JsonPath sintaksę: product.name ir $.product.name reiškia tą patį, masyvo elementas yra, pvz., $.items[0].price. POST užklausos siunčiamos su antraštė Content-Type: application/json; charset=utf-8.

Pavyzdys​

Užklausa nuskaičius kodą 5901234567890:

GET https://api.example.com/price?code=5901234567890
Authorization: Bearer eyJhbGciOi...

Atsakas, kurį kainų tikrintuvas supranta:

{
"product": {
"name": "Coffee beans 1 kg",
"price": 59.99,
"ean": "5901234567890"
}
}

Nustatymai: Path to name product.name, Path to price product.price, Path to EAN product.ean. Kainą grąžinkite kaip skaičių su dešimtaini tašku — kainų tikrintuvas ją suformatuos pagal lauką Price format.

Reikalavimai API​

  • Radus prekę, API atsako 2xx būsena ir JSON, kuriame yra pavadinimas ir kaina.
  • Bet koks kitas atsakas (pvz., 404 nežinomam kodui, 401 negaliojančiam žetonui, trūkstamas JSON laukas) ekrane parodo Data download error. Su REST API programėlė nerodo „Product not found“ — jei norite, kad pirkėjai šiuos atvejus atskirtų, grąžinkite, pvz., pavadinimą „Product not available“ su kaina 0.
  • Kodas į URL įterpiamas nekoduojant. EAN kodai ir tipiniai simboliai problemų nekelia; jei jūsų simboliuose yra tarpų ar specialiųjų ženklų, naudokite POST užklausą su kodu turinyje.
  • Žetonas gaunamas tik paleidus programėlę ir išsaugojus nustatymus — programėlė pati jo neatnaujina. Naudokite ilgalaikį žetoną arba raktą, kuris nesibaigia; pasibaigus žetono galiojimui, padeda programėlės paleidimas iš naujo.

Connection test nustatymuose tikrina tik žetono užklausą. Kai žetono adresas tuščias, patikra visada sėkminga — tikroji patikra yra kelių prekių nuskaitymas išsaugojus nustatymus.

REST API — DUK

Kaip prijungti HDWR kainų tikrintuvą prie savo sistemos?
Pasirinkite šaltinį Rest API ir įveskite prekės užklausos adresą su vietos žymekliu {code} ten, kur turi būti kodas, pvz., https://api.example.com/price?code={code}, taip pat kelius iki pavadinimo ir kainos JSON atsake. Jei reikia, įveskite adresą, iš kurio programėlė gaus Bearer žetoną.
Kodėl su REST API kainų tikrintuvas rodo Data download error, o ne Product not found?
Su REST API kiekvienas atsakas, nesantis 2xx, arba atsakas be pavadinimo ar kainos lauko laikomas klaida. Jei API nežinomam kodui grąžina 404, ekrane rodoma Data download error.
Ar programėlė atnaujina REST API žetoną?
Ne. Žetonas gaunamas paleidus programėlę ir išsaugojus nustatymus. Naudokite ilgalaikį žetoną; jam pasibaigus, paleiskite programėlę iš naujo.
Ar kainų tikrintuvas palaiko paprastą HTTP?
Taip, palaiko ir http, ir https. Parduotuvės vietiniame tinkle galite naudoti http; internete veikiančiam API naudokite https.