|
External API Tokens
Evotix 360 supports integration with external REST APIs which require simple OAuth-style authentication. Using our External API Token configuration forms, you can define the settings required to retrieve an OAuth token which can used in subsequent REST API calls.
You can use this authentication mechanism for Rest Callouts and importing data via Rest API. The API tokens will be cached for 60 minutes by the system and then the system will automatically request for a new token to ensure the Rest Callouts/Data Imports via API work seamlessly as configured.
|
PLEASE NOTE:
- To be able to setup the API Tokens, users will need to have the Role "Policy Role - Maintain External API Tokens" assigned to them
|
To setup an External API Token, navigate Designer  Security External API Tokens, and create New.
The Request page has the information that the application will use to make the API call to retrieve a token, which will then be used in subsequent REST API calls to send or retrieve data.
Field
|
Notes
|
Name
|
Specify the Name that relates to this token.
|
URL
|
URL to retrieve the API token from.
Example: https://myHRData/rest/api/v1.1/authtoken
|
HTTP Method
|
HTTP method used when making the request:
|
Authorization Method
|
Method in which the token request is authorized:
- Basic Authentication (in Header)
- Query Parameters
|
Username
|
Username used to request the API Token.
|
Password
|
Password used to request the API Token. The password will appear hashed out on save.
|
Username Parameter Name
|
When [Authorization Method] is 'Query parameter', this specifies the parameter name which sends the Username details.
|
Password Parameter Name
|
When [Authorization Method] is 'Query parameter', this specifies the parameter name which sends the Password details.
|
Token Attribute Name
|
The name of the attribute in the JSON response that contains the token.
|
Extra Parameters
|
If there are additional parameters that are required to pass, enter the Name and Values of them in the subform.
|
The Apply page has the information on how the retrieved token is used in the subsequent REST API calls made to send or retrieve data.
Field
|
Notes
|
Supply Token As
|
Select the mode in which the API token is used when making a request:
- Bearer Token (in Header)
- Query parameter
|
Token Parameter Name
|
If the [Supply Token As] is set as 'Query Parameter', this specifies the parameter name where the token needs to be applied while sending subsequent requests.
|
|
