Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

API Usage can be accessed from the Agency Admin screen.

...

Visit AgencyRoot Developers https://www.agencyroot.com/pages/developers on our website for a complete listing of our available API Modules.

...

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

Note

Copy your token and keep it somewhere safe. AgencyRoot does not have access to your token.

...

Limits

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

Info

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.

  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.

Info

When a token is deleted, it is immediately destroyed and cannot be used again.

...