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
- (Pasirinktinai) Paleidus programėlę ir išsaugojus nustatymus, kainų tikrintuvas iš žetono adreso gauna žetoną.
- 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>. - 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ą.
| Laukas | Ką įvesti | Pavyzdys |
|---|---|---|
| Url to token | Adresas, kuris grąžina žetoną. | https://api.example.com/auth |
| GET / POST | Žetono užklausos metodas. | POST |
| Body request | JSON turinys, siunčiamas su POST (laukas matomas tik esant POST). | {"user":"pricechecker","password":"…"} |
| Path to token | Kur JSON atsake yra žetonas. | token arba $.data.token |
Prekės duomenys
| Laukas | Ką įvesti | Pavyzdys |
|---|---|---|
| Url to data | Prekės užklausos adresas; {code} pakeičiamas nuskaitytu kodu. | https://api.example.com/price?code={code} |
| GET / POST | Prekės užklausos metodas. | GET |
| Body request | JSON turinys POST užklausai; čia taip pat galite naudoti {code}. | {"ean":"{code}"} |
| Path to name | Kelias iki prekės pavadinimo atsake. | product.name |
| Path to price | Kelias 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.