W3lcome API
  • Introduction
  • FAQ
  • Authentication
  • Changelog
  • Host
    • The Host Object
    • Retrieve a Host
    • Retrieve a List of Hosts
    • Insert a Host
    • Update a Host
    • Delete a Host
  • Visit
    • The Visit Object
    • Retrieve a Visit
    • Retrieve a List of Visits
    • Change Visit Status
    • Check-out a Visit
    • Check-in with Invitee Id
    • Check-out with Invitee Id
    • Delete a Visit
  • Blocked list
    • The Blocked List Object
    • Retrieve a Person on the Blocked List
    • Retrieve a List of People from the Blocked List
    • Insert a Person on the Blocked List
    • Update a Person on the Blocked List
    • Delete a Person from the Blocked List
  • Invitee
    • The Invitee Object
    • Retrieve an Invitee
    • Retrieve a List of Invitees
    • Insert an Invitee
    • Update an Invitee
    • Delete an Invitee
  • Delivery
    • The Delivery Object
  • Meeting
    • The Meeting Object
  • Notification
    • The Notification Object
  • Webhook
    • Webhook Endpoints
  • Company
    • The Company Object
    • Retrieve Company Information
    • Company Fields
  • Integration
    • W-Access
    • SBT
    • SBT QRCodes
    • Workplace by Facebook
Powered by GitBook
On this page
  • The W-Access Object
  • Methods
  • Get data
  • Post data
  • Remove data
  • Table of Errors
  • Dynamic QR Code (Host)

Was this helpful?

  1. Integration

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

totpEnabled bool

Indicates if TOTP is enabled or not. Default value: false

staticVisitorQRCode bool

If enabled the visitor is going to have a static qrcode

createdAt

string

Immutable field, updated automatically

updatedAt

string

Immutable field, updated automatically

Methods

Get data

GET https://api.w3lcome.com/v1/integration/waccess

This endpoint allows you to get the W-Access configurations

Headers

Name
Type
Description

Content-Type

string

application/JSON

Authentication

string

Basic token

{    
    "enabled": true,
    "aesKey": "longSecretKey",   
    "qrcodeDuration": 21600,
    "url": "http://192.168.100.36/checkin",
    "username": "w3lcome.token",
    "password": "Vy1BY2Vzcy1Ub2tlbg",
    "totpEnabled": false,
    "staticVisitorQRCode": false,
    "createdAt": "2020-03-11T19:21:26.970Z",
    "updatedAt": "2020-03-11T19:21:26.970Z"
}
{    
    "type": "NOT_FOUND"
}

Post data

POST https://api.w3lcome.com/v1/integration/waccess

This endpoint allows you to update the W-Access configurations

Headers

Name
Type
Description

Content-Type

string

application/JSON

Authentication

string

Basic token

Request Body

Name
Type
Description

staticVisitorQRCode

boolean

Default false

totpEnabled

boolean

Default false

username

string

Default ""

password

string

Default ""

url

string

Default ""

enabled

boolean

Default: false

aesKey

string

Default: ""

qrcodeDuration

number

Default: 30

{
    "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"
}
{
    "type": "INVALID_PARAMETER"
}

Remove data

DELETE https://api.w3lcome.com/v1/integration/waccess

This endpoint allows you to delete the W-Access configurations

Headers

Name
Type
Description

Content-Type

string

application/JSON

Authentication

string

Basic token

{
    "success": true
}
{
    "type": "INTERNAL"
}

Table of Errors

Method

Type

Description

GET

NOT_FOUND

POST

INVALID_PARAMETER

*

INTERNAL

UNAUTHORIZED

Dynamic QR Code (Host)

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
}
PreviousCompany FieldsNextSBT

Last updated 4 years ago

Was this helpful?

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

Host