triPOS®

Barcode Endpoint

Barcode Endpoint

Use the GET /api/v1/barcode/{laneId} endpoint to initiate a scan on a barcode capable PIN pad and retrieve the scanned data.

Parameters

Configure the barcode reader's illumination, image, and lighting modes by including optional parameters in the request. Additionally, select the amount of time triPOS waits for a barcode scan by setting the timeout parameter (in seconds). The default is 60 seconds.

Configuring the barcode reader's illumination (scanLightsOn and aimerLightsOn) through optional parameters in the request overrides the default values which remain the same until the user explicitly changes the values in another request. Both scanLightsOn and aimerLightsOn are enabled by default.

Set the useTrigger parameter to enable the barcode reader's trigger or have the scanner turn on automatically when a request is received. The trigger is enabled by default.

Response

If successful, the scanned data is returned in the form of a Base64 encoded string along with the symbology of the barcode.

Example Barcode Request

GET http://localhost:8080/api/v1/barcode/1?aimerLightsOn=true&scanLightsOn=true&Image=_2D&Lighting=LongerExposure&useTrigger=true&timeout=15

Supported PIN pads

triPOS Cloud