API Usage
- Heather Levin
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.
Visit API on our website for a complete listing of our available API Modules.
Generate Token
Generate a token that can be used to access AgencyRoot APIs.
Click the ‘+ Generate’ button.
Enter a unique Token name.
Select the API you wish to access.
Click ‘Generate’
Only the APIs for which your agency has an active subscription will appear in the API dropdown. Contact the AgencyRoot Support Team to subscribe.
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.
AgencyRoot currently doesn't impose any limits, but this could change in the future.
Limits can be set to notify you when a specific number of requests is reached to avoid exceeding the limit.
Click the Actions icon for the API you want to limit.
Set the Warning Limit.
Optional number of successful calls allowed per month by a User before a warning notification is sent.
Set the Critical Limit.
Optional number of successful calls allowed per month by a User before a critical notification is sent
Set the Hard Stop Limit.
Optional number of successful calls allowed per month by a User before blocking any further
requests
Click ‘Update’.
Delete Token
Tokens can be deleted individually, or all tokens can be revoked at once.
When a token is deleted, it is immediately destroyed and cannot be used again.
