XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API allows you to generate a QR code image based on the specified data through a query string parameter and returns an array of bytes which corresponds to a PNG image.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/utils/qrcode?data={data}&moduleSize={moduleSize}&errorCorrectionLevel={errorCorrectionLevel}

URI Parameters

Parameter Name Description Type Conditions
moduleSize QR Size Number
data Data field that’s used in QR encoding. String
errorCorrectionLevel Error correction level used for QR code. Number

Possible values for error correction levels.

Value Description
0 Level L (up to 7% damage)
1 Level M (up to 15% damage)
2 Level Q (up to 25% damage)
3 Level H (up to 30% damage)

Request Headers

Header Field Name Description
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-1, */*

Response

Response Body Description

Response body contains an array of bytes which corresponds to a PNG image.

Response Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.

Status Codes

A successful operation returns status code 200 (OK) for GET operations.