WhosOff API

WhosOff allows you to make use of the dedicated API service so you can link to your internal/external systems.
 

API GUIDE

Full API calls and documentation are available at www.whosoff.com/features/api. The online documents each call that can be made, along with example data and quick copy cURL scripts for use with a program such as Postman.

To access the API you will need an API token, which a Super User will be able to manage through your account. Each user with access to the API will be able to access all calls available within the API, bear this in mind when you distribute access credentials. 
 

SETUP 

To enable API access on your account follow these steps:

1. Login to your WhosOff account (as a Super User)
2. From the Administration menu click on Company Settings
3. Click on the API Access tab
4. Click on Enable API Access
5. Your App ID and Client Secret will be generated and presented at this time.

To revoke API access at any time follow these steps:

1. Login to your WhosOff account (as a Super User) 
2. From the Administration menu click on Company Settings
3. Click on the API Access tab
4. Click on Revoke API Access

SECURITY

In order to request any data through the API, authentication will need to be successfully completed in order to obtain a bearer token. This token, along with an IP address, a number once (nOnce), secret and Unique App ID must be supplied with each call.

More details on authentication can be read on the API documentation, link above.

IP RESTRICTIONS 

Super Users maintain access control on your account and can restrict the API calls further by limiting the requests from specified IP addresses. Only IPv4 addresses are supported at this time and can be managed within the API Access setup area of your account.