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.

To find your account's API endpoint:

• In Fresh Relevance, expand the User menu in the bottom left. Your account region is displayed in the menu.

• Use the API to 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 regional 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. If you attempt to do so, your requests return a 403 - Forbidden: Access is denied error.

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 - Retrieve Experiences content.
  • Content API - Server-side personalization.
  • Custom Data Tables API - Store tabular data.
  • Folders API - Manage content folders.
  • Product Import - Import your product catalog.
  • SmartBlocks API - Manage SmartBlocks.
  • Statistics - Monitor Fresh Relevance's performance.
• JavaScript API - 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 - Capture beacon events, and access Fresh Relevance data from PWA and mobile apps.

📘

Checking availability

You can check the platform's status on our status page .