REST API
Met de bron Rest API verbindt u de prijsscanner met elk systeem dat voor een opgegeven code de naam en de prijs van een product in JSON teruggeeft — bijv. een webwinkel, een kassasysteem of uw eigen tussenlaag.
Hoe het werkt
- (Optioneel) Bij het starten van de app en nadat de instellingen zijn opgeslagen, haalt de prijsscanner een token op bij de token-URL.
- Na elke scan stuurt hij een verzoek naar de data-URL, waarin
{code}wordt vervangen door de gescande code. Heeft hij een token, dan voegt hij de headerAuthorization: Bearer <token>toe. - Hij leest de naam, de prijs en optioneel de EAN uit het JSON-antwoord — met de paden die u opgeeft.
Zowel http:// als https:// werken. De app wacht ongeveer 10 seconden op een antwoord.
Velden
Token (optioneel) — laat Url to token leeg als de API geen authenticatie vereist.
| Veld | Wat in te vullen | Voorbeeld |
|---|---|---|
| Url to token | Het adres dat het token teruggeeft. | https://api.example.com/auth |
| GET / POST | Methode van het tokenverzoek. | POST |
| Body request | De JSON-body die met POST wordt verstuurd (het veld is alleen bij POST zichtbaar). | {"user":"pricechecker","password":"…"} |
| Path to token | Waar het token in het JSON-antwoord staat. | token of $.data.token |
Productgegevens
| Veld | Wat in te vullen | Voorbeeld |
|---|---|---|
| Url to data | Het adres voor het productverzoek; {code} wordt vervangen door de gescande code. | https://api.example.com/price?code={code} |
| GET / POST | Methode van het productverzoek. | GET |
| Body request | De JSON-body voor POST; ook hier kunt u {code} gebruiken. | {"ean":"{code}"} |
| Path to name | Pad naar de productnaam in het antwoord. | product.name |
| Path to price | Pad naar de prijs; de waarde moet een getal zijn. | product.price |
| Path to EAN (optional) | Pad naar de EAN-code die onder de prijs wordt getoond. Leeg = onder de prijs wordt de gescande code getoond. | product.ean |
De paden gebruiken de JsonPath-syntaxis: product.name en $.product.name betekenen hetzelfde, een array-element is bijv. $.items[0].price. POST-verzoeken worden verstuurd met de header Content-Type: application/json; charset=utf-8.
Voorbeeld
Het verzoek na het scannen van de code 5901234567890:
GET https://api.example.com/price?code=5901234567890
Authorization: Bearer eyJhbGciOi...
Een antwoord dat de prijsscanner begrijpt:
{
"product": {
"name": "Coffee beans 1 kg",
"price": 59.99,
"ean": "5901234567890"
}
}
Instellingen: Path to name product.name, Path to price product.price, Path to EAN product.ean. Geef de prijs terug als getal met een decimaalpunt — de prijsscanner formatteert die volgens het veld Price format.
Vereisten voor de API
- Voor een gevonden product antwoordt de API met een 2xx-status en JSON die de naam en de prijs bevat.
- Elk ander antwoord (bijv. 404 voor een onbekende code, 401 voor een ongeldig token, een ontbrekend veld in de JSON) toont Data download error op het scherm. Bij REST API toont de app niet „Product not found” — wilt u dat klanten deze gevallen kunnen onderscheiden, geef dan bijv. de naam „Product not available” terug met prijs 0.
- De code wordt zonder codering in de URL ingevoegd. EAN-codes en gangbare symbolen geven geen problemen; bevatten uw symbolen spaties of speciale tekens, gebruik dan een POST-verzoek met de code in de body.
- Het token wordt alleen opgehaald bij het starten van de app en nadat de instellingen zijn opgeslagen — de app vernieuwt het niet zelf. Gebruik een langdurig token of een sleutel die niet verloopt; nadat het token is verlopen, helpt het herstarten van de app.
De Connection test in de instellingen controleert alleen het tokenverzoek. Is de token-URL leeg, dan slaagt de test altijd — de echte controle is het scannen van een paar producten na het opslaan van de instellingen.