Versions Compared

Key

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

The User Manual has moved! For the most up-to-date information, please visit our new site at docs.antavo.com.
We're committed to providing you with the best resources, and our new site offers an enhanced experience with the latest documentation. Thank you for your understanding and continued support.

The API tab is the interface where you can browse API credentials and functionalities, and define access restrictions.

...

  • Events - submit API events

  • Customers - access endpoints of the Customer API

...

  • Errors - browse the entire content of the requests and Antavo’s responses to failed API calls.

Info

As a security measure, customer passwords that may be included in requests are never exposed in the logs.

Read more in the API documentation.

...

Info

This tab is only available if the IP filter module has been enabled in the BackofficleBackoffice. Please contact the Antavo Service Desk to help you activate the module.

...

You can remove filters using the (blue star) button anytime.

Signature enforcement

Info

The Signature enforcement tab is available ifthe if the API signature check module is enabled. Please contact the Antavo Service Desk if you want to start using this feature.

If signature enforcement is enabled for an API endpoint then requests with plain API keys are rejected with an authentication error, only the requests with proper signatures can be recorded.
Learn more on how to add signatures to your API requests here.

Use the checkboxes to enable signature enforcement for any of the available endpoints.

...

  • Challenges API

    Status
    colourRed
    titledeprecated soon

  • Coupons API

  • Customer API

  • Workflow Campaigns Display API

  • Entities API

  • Events API

  • FAQ API

  • Leaderboard API

  • Levels API (legacy endpoint)

    Status
    colourYellow
    titlelegacy

  • Offers API

  • Rewards API

  • Coupons API

  • Events APIWallet API

    Status
    colourRed
    titledeprecated soon

  • Workflow Campaigns API

...

Don’t forget to click ‘Update’ before leaving the page to make your changes effective.