API Usage

AgencyRoot’s API Usage screen provides your developers with the tools they need to generate tokens and monitor usage.

API Usage can be accessed from the Agency Admin screen.

Open

Generate Token

Generate a token that can be used to access AgencyRoot APIs.

1. Click the ‘+ Generate’ button.

2. Enter a unique Token name.

3. Select the API you wish to access.

4. Click ‘Generate’

Open

Copy Token

When you generate the token, it will be displayed only once, immediately after its generation.

Limits

When you subscribe to an API, the system will make the API available for limiting.

Limits can be set to notify you when a specific number of requests is reached to avoid exceeding the limit.

1. Click the Actions icon for the API you want to limit.

2. Set the Warning Limit.

   • Optional number of successful calls allowed per month by a User before a warning notification is sent.

3. Set the Critical Limit.

   • Optional number of successful calls allowed per month by a User before a critical notification is sent

4. Set the Hard Stop Limit.

   • Optional number of successful calls allowed per month by a User before blocking any further

      requests

5. Click ‘Update’.

Delete Token

Tokens can be deleted individually, or all tokens can be revoked at once.