Authentication for our API users is based on an access key system. To find your access key, navigate to the Alocity portal and, once logged in, navigate to the settings page by clicking on the gear icon at the top of the page. Once on the settings page, click on the Integration card.
Using the endpoint on this page and a valid access key, you will be able to request a JWT token for use in other endpoints. Note that every time you generate a JWT token, the previous one will be invalidated.
For all other requests, the authorization header of those requests will need to be set to:
Authorization: Bearer Token_HereControlled Errors
These are the error codes that will be returned when the hasErrors property is equal to true.
Error Code | Error Message |
|---|---|
error_accesskey_not_found | Invalid Access Key provided |
error_accesskey_is_inactive | Access Key was either deactivated or has expired. |
error_user_not_found | API user was not found for your account. Please contact support. |
failed_system_operation | Operation Failed |