Skip to main content

ProGlove Documentation

Gateway pairing code

The Gateway pairing code is a request to receive the Gateway's pairing code.

Response: If successful, user receives the pairing code to build a QR code image and pair scanners to this Gateway.

Name

Type

Description

Accepted values

Constraints

Required

api_version

string

The input API schema version number.

1.0

Yes

event_type

string

The message type.

gateway_state!

Yes

event_id

string

The message identifier. This can be used to reference it.

Any

UUID format [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Yes

time_created

integer

The time of creation client-side, used to determine the order of incoming messages. Unix time stamp in milliseconds.

Any

1546300800000 <= value <= 99999999999999

Yes

gateway_serial

string

The serial number of the Gateway that will receive the command.

Any

1 <= length <= 128

Yes

Example
GET_PAIRING_CODE_REQUEST = {
    "api_version": "3.0",
    "event_type": "gateway_pairing_code!",
    "event_id": "02114da8-feae-46e3-8b00-a3f7ea8672df",
    "time_created": 1546300800000,
    "gateway_serial": "PGGW402537269"
}
In this section: