User Authentication Token

Tokens API

All API methods require a security token to use the system. This token is stored in the HTTP cookie to allow multiple API calls from one authentication request. A token is requested by authenticating with a username and password combination.

Token URL

• Method: POST

• Endpoint: /omni/user/authorize

• System Authorization: Authorization: Key=your-auth-key

The Token service API will return a token on success.

Password

The password needs to be converted to Base64 with ASCII encoding to get the bytes[] from the password string.

Steps:

1. Make a request to the token Uri.

2. Store token key for any subsequent requests.

3. Make an API request.

Recommendations

• It is recommended that you keep track of the Token Key and its expiry as making a request every time can slow down the process.

When a successful API call is made to the API Token service, it will return a JSON object. A user token key must be passed to each API endpoint along with the request.