W-Access

The W-Access Object

Attribute

Description

enabled bool

Boolean indicating if the integration is active or not

aesKey string

AES key used to encrypt the host QR Code

qrcodeDuration int

Duration (in seconds) that the QR Code will still be valid

url string

If provided, the iPad will make a local POST request to this URL after the visitor finishes its check-in on the iPad

username string

It will be used to authenticate during the local POST request

password

string

It will be used to authenticate during the local POST request

createdAt

string

Immutable field, updated automatically

updatedAt

string

Immutable field, updated automatically

Methods

get
Get data

https://api.w3lcome.com/v1/integration/waccess
This endpoint allows you to get the W-Access configurations
Request
Response
Request
Headers
Content-Type
required
string
application/JSON
Authentication
required
string
Basic token
Response
200: OK
Success
{
"enabled": true,
"aesKey": "longSecretKey",
"qrcodeDuration": 21600,
"url": "http://192.168.100.36/checkin",
"username": "w3lcome.token",
"password": "Vy1BY2Vzcy1Ub2tlbg",
"createdAt": "2020-03-11T19:21:26.970Z",
"updatedAt": "2020-03-11T19:21:26.970Z"
}
404: Not Found
Error
{
"type": "NOT_FOUND"
}

post
Post data

https://api.w3lcome.com/v1/integration/waccess
This endpoint allows you to update the W-Access configurations
Request
Response
Request
Headers
Content-Type
required
string
application/JSON
Authentication
required
string
Basic token
Body Parameters
username
optional
string
Default ""
password
optional
string
Default ""
url
optional
string
Default ""
enabled
optional
boolean
Default: false
aesKey
optional
string
Default: ""
qrcodeDuration
optional
number
Default: 30
Response
200: OK
Success
{
"enabled": true,
"aesKey": "newLongSecretKey",
"qrcodeDuration": 3600,
"url": "http://192.168.100.36/checkin"
"username": "w3lcome.token",
"password": "Vy1BY2Vzcy1Ub2tlbg",
"createdAt": "2020-03-11T19:21:26.970Z",
"updatedAt": "2020-03-12T16:39:22.970Z"
}
400: Bad Request
Error
{
"type": "INVALID_PARAMETER"
}

delete
Remove data

https://api.w3lcome.com/v1/integration/waccess
This endpoint allows you to delete the W-Access configurations
Request
Response
Request
Headers
Content-Type
required
string
application/JSON
Authentication
required
string
Basic token
Response
200: OK
Success
{
"success": true
}
500: Internal Server Error
Error
{
"type": "INTERNAL"
}

Table of Errors

Method

Type

Description

GET

NOT_FOUND

POST

INVALID_PARAMETER

*

INTERNAL

UNAUTHORIZED

Dynamic QR Code (Host)

To use the dynamic QR Code, the Host must have the property wAccessCardNumber under metadata which is an Int32

Valid Sample

{
"name": "Alisson Enz",
"email": "alisson@w3lcome.com",
"metadata": {
"wAccessCardNumber": 123456
}
}

Invalid Sample

It will not work, the system only accepts custom fields under metadata

{
"name": "Alisson Error",
"email": "alisson@error.com",
"wAccessCardNumber": 123456
}