QR
This integration allows to scan, manage and operate QR and barcodes.
Note
The integration described in this article may not be implemented in your environment or enabled for all your clients. Contact your admin for assistance.
Technical Details
API ID | 124 |
API Code | QR |
Call API version | 4 |
App Version | Initial |
Objective | Read and generate QR and barcodes. |
Classification | QR |
Available for | iOS, Android |
Use the QR Integration in Studio
The following functions are available for use in your legacy processes, and you can also use them as blocks in Lambda processes. Click each function to see more details.
Generate an image with the QR code with the "Text to encode" parameter and save it in "Image ID" so that it is available for the application. | |
Use the device's camera to scan QR and barcodes. |
Generate QR
This function generates an image with the QR code and saves it, so that it is available for the application.
Parameter Configuration
This function requires you to complete the input parameters with the text to encode and an image ID. Refer to the Input Registers section to learn more.
Function ID
Register | Value |
|---|---|
110 | 1 |
Input Registers
Register | Description | Mandatory | Value |
|---|---|---|---|
332 | Text to encode | Yes | Valid text to be transformed into a QR code. |
333 | Image ID | Yes | String |
Output Registers
Register | Description | Value | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Call Result | Table 1. Version 2
Table 2. Version 3
|
Read QR
This function enables you to use the device's camera to scan a QR or barcode (depending on the code format filters applied) and saves the result in "Decoder Text".
Parameter Configuration
This function requires you to complete input parameters with a timeout, and several non-mandatory parameters such as image size or input source. See the Input Registers section to learn more.
Function ID
Register | Value |
|---|---|
110 | 2 |
Input Registers
Register | Description | Mandatory | Value |
|---|---|---|---|
334 | Timeout | Yes | Timeout to successfully reading the QR or barcode. |
356 | Code Formats to Decode | No | <<QR FORMAT FILTER>>. Read Code Formats to Decode to learn more. |
392 | Input Code Source | No | Use file to obtain the code from an image file, or use camera to obtain the code from the device's camera. If left blank, the default value is camera. |
393 | Max Image File Width Size | No | Image width size limit in pixels, example: 1024. It only works when configuring the code source parameter with the file value. |
393 | Max Image File Height Size | No | Image height size limit in pixels, example: 768. It only works when configuring the code source parameter with the file value. |
Code Formats to Decode
See below to learn about the code formats to decode (parameter 356).
Value | Description | Type |
|---|---|---|
Blank | No filter applied, all formats are supported | 1D, 2D |
1D | Any 1D barcode supported by platform | 1D |
2D | Any 2D barcode supported by platform | 2D |
QR | QR format | 2D |
BARCODE | Any 1D barcode supported by platform (backward compatibility) | 1D |
CODE_39 | Barcode format | 1D |
CODE_93 | Barcode format | 1D |
CODE_128 | Barcode format | 1D |
EAN_8 | Barcode format | 1D |
EAN_13 | Barcode format | 1D |
ITF | ITF barcode format | 1D |
RSS_14 | Barcode format (if supported by platform) | 1D |
RSS_EXPANDED | Barcode format (if supported by platform) | 1D |
UPC_A | Barcode format (if supported by platform) | 1D |
UPC_E | Barcode format | 1D |
DATAMATRIX | 2D code format | 2D |
INTERLEAVED_2_OF_5 | ITF barcode format | 1D |
AZTEC | Barcode format | 2D |
PDF_417 | Linear barcode format | 2D |
Output Registers
Register | Description | Value | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Call Result | Table 3. Version 2
Table 4. Version 3
Table 5. Version 4
| ||||||||||||||||||||||||||||||||||||||||||||||||
335 | Decoder Text, Call Result | <<REGISTRATION_ID>> |