Core Attributes of all API

These post explains the architecture of the API backend. Helpful for all the API.

Getting Started

All the API require a 'tenant' key within its call. Most Tenant key ends with a '_db'

'tenant': 'brandname_db'

If you do not have tenant key, please reach out to your client for more information. We cannot provide tenant key for any client.

Authentication Methods:

There are two seperate concepts for authentication: API Key & Authentication Token.

All APIs can take action on behalf of the Staffing company (Tenant) or on behalf of the user (Job Seeker or Client).

As a rule of thumb, any action taken by the user, requires that users 'Authentication Token'. You should recieve the token by using the authentication API.

Any action taken on behalf of the staffing company/ tenant, requires API key. It's always a good idea to submit the API Key for most of the request to ensure you are not denied access.

Hence when calling the API:

Call with an API KEY: when acting on behalf of the staffing company. Example getting tenant information or updating the unique coordinates.

Call with a Auth token: when requesting to view jobs and conducting check-in & check-out, etc.