| Table of Contents |
|---|
An API key is a unique token generated by the onboarding system for using in transactions with the external providers. Like basic authentication, API keys provide security for application access. The token is encrypted in the code which allows external provider have authorized access to the system.
| Table of Contents |
|---|
This option allows you to generate unique API tokens that can be used for authentication when integrating with the Smart Onboarding system.
Who can generate API
...
keys?
The API keys can be generated by users with System Administrator is the only user who can Generate API Keysrole within the system.
How do you access
...
this feature?
Click the Menu icon. Click Generate API key under Integration.
...
...
menu icon at the top left corner of the page and select "Generate API Key" from the Integration section in the navigation menu.
|
How to generate an API Token?
Click the "Generate API Token" button located in the top right corner of the page.
...
...
Enter the API Token label. Click on Show to see your API Token code.
...
...
Make a note of your API Token code that is displayed on the screen. Click OK.
...
...
The API Token that you have created is added to the list. Note that the status of the API Token is shown as Active.
...
...
|
Enter a label for the API token and click the "Show" button on the corresponding row.
|
This action will display the token code in the corresponding field. Make a note of this code, as it is needed for system interfacing. Click "OK" to return to the previous page.
|
The newly generated API token will be added to the existing list. Note that its status will be displayed as "Active". If the token is no longer needed, you can revoke it by clicking the "Revoke" button in the corresponding row.
|
To determine when the token was generated, refer to the date and time stamp displayed under the "Last Accessed" column.
|
How to revoke an API
...
token?
If you no longer
...
need the generated API token
...
, you can disable
...
...
it by using the "Revoke" button.
Click the "Revoke" button in the row of the API token you wish to disable.
...
...
 |
After the token is disabled, its status will change to "Revoked" as shown below.
...
...
...
 |