Ga naar hoofdinhoud

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​

  1. (Optioneel) Bij het starten van de app en nadat de instellingen zijn opgeslagen, haalt de prijsscanner een token op bij de token-URL.
  2. 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 header Authorization: Bearer <token> toe.
  3. 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.

VeldWat in te vullenVoorbeeld
Url to tokenHet adres dat het token teruggeeft.https://api.example.com/auth
GET / POSTMethode van het tokenverzoek.POST
Body requestDe JSON-body die met POST wordt verstuurd (het veld is alleen bij POST zichtbaar).{"user":"pricechecker","password":"…"}
Path to tokenWaar het token in het JSON-antwoord staat.token of $.data.token

Productgegevens

VeldWat in te vullenVoorbeeld
Url to dataHet adres voor het productverzoek; {code} wordt vervangen door de gescande code.https://api.example.com/price?code={code}
GET / POSTMethode van het productverzoek.GET
Body requestDe JSON-body voor POST; ook hier kunt u {code} gebruiken.{"ean":"{code}"}
Path to namePad naar de productnaam in het antwoord.product.name
Path to pricePad 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.

REST API — veelgestelde vragen

Hoe verbind ik de HDWR-prijsscanner met mijn eigen systeem?
Kies de bron Rest API en voer het adres van het productverzoek in met de plaatsaanduiding {code} waar de code moet komen, bijv. https://api.example.com/price?code={code}, plus de paden naar de naam en de prijs in het JSON-antwoord. Voer optioneel een adres in waar de app een Bearer-token ophaalt.
Waarom toont de prijsscanner bij REST API Data download error in plaats van Product not found?
Bij REST API wordt elk antwoord dat geen 2xx is, of een antwoord zonder het veld voor naam of prijs, als fout behandeld. Geeft de API 404 terug voor een onbekende code, dan toont het scherm Data download error.
Vernieuwt de app het REST API-token?
Nee. Het token wordt opgehaald bij het starten van de app en nadat de instellingen zijn opgeslagen. Gebruik een langdurig token; nadat het is verlopen, herstart u de app.
Ondersteunt de prijsscanner gewone HTTP?
Ja, hij ondersteunt http en https. In het lokale netwerk van de winkel kunt u http gebruiken; voor een API op internet gebruikt u https.