Access Control


Access control endpoint

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

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


Base URL

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

"xyz" represent your account sub-domain. It is the prefix to ".spaces.nexudus.com" on your members portal.


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.

Calling this API method requires your App to be assinged one of the following roles:

  • None

POST https://xyz.spaces.nexudus.com/api/public/checkin
Request Url: /api/public/checkin
Request Method: POST
Request Params: {
  AccessCardId: '12345'
}

Response Status Code: 200
Response Body:
{
    "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

Calling this API method requires your App to be assinged one of the following roles:

  • None

POST https://xyz.spaces.nexudus.com/api/public/checkin
Request Url: /api/public/checkin
Request Method: POST
Request Params: {
  Email: 'sampe@sample.com',
  Password: 'pwd',
  Mac: 'AA:BB:CC:DD:EE:FF'
}

OR

Request Url: /api/public/checkin
Request Method: POST
Request Params: {
  Token: 'XYZ1234',
  Mac: 'AA:BB:CC:DD:EE:FF'
}

Response Status Code: 200
Response Body:
{
    "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 API method requires your App to be assinged one of the following roles:

  • None

POST https://xyz.spaces.nexudus.com/api/public/checkin
Request Url: /api/public/checkin
Request Method: POST
Request Params: {
  Mac: 'AA:BB:CC:DD:EE:FF'
}

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

Parameters

You can pass the following parameters to all check-in endpoints:

  {
    Toogle: true, //Toggles between check in and out on every request
    Disconnect: true //Checks this user out
   }

Related API Resources




Source: XML ! RSS