Adding a new API application registration

Owned by Roar Hansen (Deactivated)
Jun 04, 2019
2 min read

In order to use the Collaborate API, an API application registration is required.  (Please note that the API is enabled by default but can be disabled at the instance level. 
If you do not see the API application registration option in system admin then please email support@highq.com to enable the API for your instance.)


A new API application registration can be found within the system admin interface accessed by the system administrators. 


The steps are: 

Navigate to Collaborate System administration and then choose API application registration. Click on Add application to create a new application registration.

Fill out the fields in the Application registration to create a new application registration.

  • All fields marked with asterisk * are mandatory and must be completed
  • The Secret key is generated automatically but you can generate it again by clicking on "Generate key". This key is critical, once you create the application registration you will need to use this client ID and secret key to generate the OAuth token. 
  • Redirect URL is the URL to which the OAuth code will be generated, this can be used to limit how the OAuth code is generated and is for added security.  This value can also be used to redirect the code generated to a desktop application rather than a web URL. 
  • The token expiration time can be used to set the time after which the generated OAuth token will expire and the client will need to use the refresh token to create a new OAuth token. 
  • Status field can be used to archive the application registration in case there is a security breach or some other cause of shutting down the clients using the particular application registration. 
  • The Show allow/deny screen option can be used to display the authorisation screen after the user logs into Collaborate to generate the OAuth token. This screen can prevent users from accepting the API token generation accidentally when they have a valid Collaborate session. 
  • The Application rate limit settings and Access type fields are not visible to system admin and are managed by HighQ.

Click Save to save the new application registration. 

Once saved, you can use the generated Client ID and Secret key for this application registration to generate the new OAuth token. 

ayfie