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. 

Who can generate API Keys?

The System Administrator is the only user who can Generate API Keys.

How do you access Generate API Key?

Click the Menu icon. Click Generate API key under Integration.

How to generate an API Token?

Click Generate API Token.

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.

How to revoke an API Token?

If you no longer use the API token for external provider integration, you can disable the API Key using Revoke option. Follow the steps below to revoke an API key.

Click Revoke for the API key that you want to disable.

The status will be changed to Revoked as shown below.