| Table of Contents |
|---|
This option allows you to generate unique API tokens which that can be used as an 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 Integrationmenu 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 on the "Generate API Token" button located in the top right corner of the page.
|
Enter a label for the API Token label. Click on Show to see your API Token code.
...
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 your API Token code that is displayed on the screen. Click OKthis code, as it is needed for system interfacing. Click "OK" to return to the previous page.
|
The newly generated API token that you have created is will be added to the existing list. Note that the status of the API Token is showing as Active.
...
You will see 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" date displayed for the token when the token is accessedcolumn.
|
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 API token is disabled, the its status changes will change to "Revoked" as shown below.
...