Barcode API

Het is mogelijk om via onze Barcode API GS1 en HIBC barcodes te ontleden. Deze API is specifiek ontwikkeld om het ontleden van barcodes te optimaliseren en te vereenvoudigen.

Het gebruiken van de Barcode API

Om de Barcode API te gebruiken, dient er een JSON request naar het API endpoint gestuurd te worden. Het request object heeft de onderstaande structuur:

1. barcode (verplicht): Dit veld bevat de volledige barcode string die zal worden ontleedt. Als de barcode via een barcode scan wordt meegegeven, dan zal de AIM identifier ook moeten worden meegegeven als prefix.
2. hibcOptions (optioneel): Indien een HIBC barcode is gespecificeerd, kunnen een drietal (boolean) opties worden meegestuurd die het ontledingsproces zullen beïnvloeden. Deze opties kunnen als volgt worden gedefinieerd:
   • zimmerCompatible: Geeft aan of de HIBC barcode voldoet aan de Zimmer-standaard. Dit houdt in dat er aan het BatchLot onderdeel van de barcode drie karakters kunnen zijn toegevoegd. Deze 3 karakters zijn in dat geval altijd een letter gevolgd door twee numerieke karakters. Als deze optie AAN staat, zullen deze 3 karakters van batch/lot afgeknipt worden.
   • includeLabelerIdInProductNumber: Specificeert of de Labeler Identification Code (LIC) onderdeel moet zijn van het product nummer.
   • includeUnitOfMeasureInProductNumber: Bepaalt of de eenheid van maat (Unit of Measure) in het productnummer opgenomen moet worden.

Bekijk het JSON-voorbeeld voor de precieze opmaak van het request. Door de barcode en eventuele hibcOptions correct aan te leveren, zal de API de barcode ontleden en de relevante informatie retourneren.

Voorbeeld:

{
  "barcode": "]C0+H124328105025081%",
  "hibcOptions": {
    "zimmerCompatible": false,
    "includeLabelerIdInProductNumber": true,
    "includeUnitOfMeasureInProductNumber": true
  }
}

Authenticatie

Voor het gebruik van de barcode API is het vereist dat de client een geldig JWT bearer token in de authenticatie header van de request meestuurt. Een JWT bearer token kan worden opgevraagd door een request nnar de AUTH api te sturen met een geldig clientid en secret.

curl --location "https://auth-staging.trancon.nl/connect/token" \
--header "Content-Type: application/x-www-form-urlencoded" \
--header "Authorization: Basic <[user:password] base64 encoded>" \
--data-urlencode "grant_type=client_credentials"

Vervolgens kan de resulterende JWT-token worden gebruikt in the Authorization header om requests te sturen naar de barcode API.

curl -H "Authorization: Bearer <JWT-Token>" https://app-staging.boxwise.nl/barcode/api/parse

Backwards compatibility met Boxwise

Het ontleden van barcodes binnen Boxwise wordt afgehandeld door Python. Boxwise gebruikt standaard de volgende HIBC-instellingen: ZimmerCompatible is ingesteld op False, terwijl zowel IncludeLabelerIdInProductNumber als IncludeUnitOfMeasureInProductNumber standaard op True staan. Voor een correcte werking is het essentieel dat de HIBC-opties die binnen Boxwise zijn geconfigureerd, exact overeenkomen met de hibcOptions die aan de Barcode API worden meegegeven.

Test applicatie  

Om testen wat te vergemakkelijken kun je bijgesloten test applicatie gebruiken. Deze laat de gescande barcode zien die is ingegeven in het Invoer veld (zet de cursor hierin en scan de barcode met een barcode scanner die in USB Keyboard Wegde mode staat of gebruik de directe scanner verbinding via WebHID). 

Als je wilt dat de test applicatie de barcode ook ontleed met de Boxwise Barcode API dan zul je onder API instellingen een Client Id en Client Secret moeten ingeven die de rechten heeft om de Barcode API aan te roepen. Deze worden alleen door ons aan je verstrekt.