Access Control

This API endpoint lets you check customers in and out based on their username/password, an access card ID or an access token.

When testing this endpoint, ensure the member or contact you are trying these requests for has at least one unused time pass in their account. You can manually add a time pass to a member from the Benefits > Passes tab in their account.

Access Control Update Webhook

If you plan to connect your own access control provider, Nexudus provides a webhook which will trigger every time a potential change in the access levels for the customer that has changed. This webhook should be used as the trigger for any logic and updated you perform in the access control system.

 

Base URL

These endpoints use the URL associated with the location you plan to check customers in. "xyz" in the example below represents the sub-domain associated with the Nexudus account for the location you plan to check customer sin.. It is the prefix to ".spaces.nexudus.com" on your members portal.

https://xyz.spaces.nexudus.com/api/public/checkin

Common Parameters

All the endpoints below support the following parameters

Parameter Description
Toggle Toggles between check-in and out on every request.
Disconnect Checks the customer out.

 

Check-in by Access Card ID

Each member or contact can have one or more access card IDs. Enter these in the "Integrations" tab for each of them.

POST https://xyz.spaces.nexudus.com/api/public/checkin
Content-Type: application/json

🔒 Requires no roles

{
	"AccessCardId": "12345"
}

Example valid response

{ 
  "Status": 200,
  "Message": "2015-09-11T21:59:59 UTC",
  "Value": {
  	"SessionExpire": "2015-09-11T21:59:59 UTC",
    "SessionTimeOut": 46455.3521501
   },
   "Errors": null,
   "WasSuccessful": true
 }

 

Check-in by Username and Password

Each member or contact can have one or more access card IDs. Enter these in the "Integrations" tab for each of them.

POST https://xyz.spaces.nexudus.com/api/public/checkin
Content-Type: application/json

🔒 Requires no roles

{
  "Email": "sampe@sample.com",
  "Password": "....",
  "Mac": "AA:BB:CC:DD:EE:FF"
}

or

{
  "Token": "XYZ1234",
  "Mac": "AA:BB:CC:DD:EE:FF"
}

Example valid response

{ 
  "Status": 200,
  "Message": "2015-09-11T21:59:59 UTC",
  "Value": {
  	"SessionExpire": "2015-09-11T21:59:59 UTC",
    "SessionTimeOut": 46455.3521501
   },
   "Errors": null,
   "WasSuccessful": true
 }

 

Check-in by MAC access token

Calling this endpoint requires users to have an associated MAC address. Logging in using username and password as detailed above will associate the passed in MAC address to the user so they can be checked in using their MAC address in the future.

You must enable Automatically check known users in based on their MAC address in your Check-in Settings for this endpoint to be available.

POST https://xyz.spaces.nexudus.com/api/public/checkin
Content-Type: application/json

🔒 Requires no roles

{
  "Mac": "AA:BB:CC:DD:EE:FF"
}

or

{
  "Token": "XYZ1234",
  "Mac": "AA:BB:CC:DD:EE:FF"
}

Example valid response

{ 
  "Status": 200,
  "Message": "2015-09-11T21:59:59 UTC",
  "Value": {
  	"SessionExpire": "2015-09-11T21:59:59 UTC",
    "SessionTimeOut": 46455.3521501
   },
   "Errors": null,
   "WasSuccessful": true
 }
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.