Authentication
Authentication is the first step to be able to communicate with the Nexus API. The following steps will show you how to create an API client in Nexus and receive your Authentication token, which will be used in all the subsequent API calls.
Create an API client
Once logged into Nexus, click on the Users menu item to switch to the Nexus Identity portal.
Go to API clients and create a new one.
Fill the client name and choose a secret (you will use the latter to request the authentication token)
Now that the API client is saved, you will have both the Client ID and Client Secret needed to create your token request!
Request the Authentication token
All you need to do now is to create a request to the identity portal for a new token, which you will need for all the API requests that will follow.
NOTE
Please ensure to use the correct URL based on your environment.
| Request | Environment | URL |
|---|---|---|
| POST | Test Token | https://testidentity.quantoz.com/connect/token |
| POST | Production Token | https://identity.quantoz.com/connect/token |
form-url-encoded body parameters
| Key | Value |
|---|---|
| client_id | value yielded in point 4. when adding the API client |
| client_secret | value previously selected when creating the client |
| scope | api1 |
| grant_type | client_credentials |
If the response is successful, you will receive the token to use further down in this tutorial. Well done!
Rate limits
For security reasons, the Authentication token endpoint has a rate limiter applied which is defined at 60 requests per minute per IP.
API endpoint URLs
As Nexus offers different environments, you should adjust the API call URLs according to your specific needs:
- Test Token environment: testapi.quantoz.com
- Production Token environment: api.quantoz.com
These are the most common ones you will probably end up using, however feel free to use the right one for your configuration.
API date/time format
If you prefer a single date/time format returned in our responses you can supply the header request_iso8601: true and the returned date/time objects will be shown in the format: yyyy-MM-ddTHH:mm:ssZ.