API browser

The Antavo Loyalty Cloud features an integrated API browser, accessible in the Management UI at the following URL.

https://loyalty.{environment}.antavo.com/{workspace_id}/api-browser/

This web interface lets you directly interact with the API functionalities, send API requests, and see corresponding API responses. It’s a commonly used tool for generating events within Antavo, testing API signatures, and viewing active customers' data.

The API browser currently supports 2 APIs and has a dedicated page to list API errors.

Customers

/api-browser/customers

This interface provides 3 options:

• Accesses two endpoints in the Customer API:
  • The Customer details option performs a customer lookup using the Antavo customer ID.
  • The Customer search option returns Antavo customer IDs for customers matching the provided criteria.
• Accesses the Leaderboard API endpoint:
  • The Customer leaderboard option returns the top-performing customers based on defined interval and limit parameters.

Events

/api-browser/events

You can submit events using the Events API. Available actions are provided in a dropdown menu, and you need to manually enter the customer ID.

Errors

/api-browser/errors

The error log shows every request and its subsequent response that results in an error within Antavo for debugging and troubleshooting purposes.