Start a job to show information and interactive buttons on the device's UI

POST

/api/display/v5/{id}

Start a job to show information and interactive buttons on the device's UI. The ID of the button pressed by the user can be retrieved using the display status endpoint.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Tag-Info job successfully created

Body

🟠400Bad Request

🟠401Unauthorized

🟠409409

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://192-168-1-1.xip.get.systems:9443/api/display/v5/' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "message": "Please choose the quantity you want to purchase.",
    "buttons": [
        {
            "title": "Buy 1",
            "id": "my_super_button",
            "style": "Neutral"
        }
    ],
    "disableIdle": true
}'

Response Example

200 - Example 1

{
    "data": {
        "statusUrl": "string",
        "cancellationUrl": "string"
    }
}

Modified at 2025-02-13 14:31:55

Start a job to swap a ticket to a NFC-tag

Start a job that prompts the end-user to scan an NFC tag