Architecture overview

Fresh Relevance is made up of many components. To help you to understand how you can integrate with it, the following diagram give you a high-level overview:

Region specific end points

Accounts belong to different regions, depending upon where they are based in the world. Our APIs require you to use the correct API endpoint for your region. This is important as you cannot use an API endpoint belonging to a different region.

If you don't know your account's correct API endpoint, then you can find this out by:

• Within the portal click on the settings cog in the bottom-left corner and in the pop-up menu you'll find the account details displayed in the top section, including the region:

• Using the API: Call Get account information using r1-api-freshrelevance.dotdigital.com as the endpoint (regardless of what region you're in), and this returns your account's correct API domain in the api_domain field.

The regions are:

🚧

Make sure you're using the correct regional API endpoint for your account

This is important as you cannot use an API endpoint belonging to a different region, and instead will receive a 403 - Forbidden: Access is denied error. See above for details of now to find your accounts region.

What's available?

The Fresh Relevance APIs are provided to allow the consumption and ingestion of data into the Fresh Relevance platform from your systems and apps. You should carefully consider which APIs are required to meet your needs.

Available APIs are:

• REST based APIs for use with your platforms and systems back-ends:
  • Activity API - Used to retrieve Experiences content.
  • Content API - Used for server-side personalization.
  • Custom Data Tables API - Used to store tabular data in Fresh Relevance.
  • Folders API - Used to manage content folders in Fresh Relevance.
  • Product Import - Used to import your product catalog into Fresh Relevance.
  • SmartBlocks API - Used to manage SmartBlocks.
  • Statistics - Used to monitor Fresh Relevance's performance.
• JavaScript APIAllows you to pass data and events from single page applications, without the need to rely on scraping or a data layer.
• Mobile and App Data Collection API - Allows you to capture beacon events, and access Fresh Relevance data from PWA and mobile apps.

📘

Checking availability

You can check the platforms status on our status page .