Thematic API - Bloomreach Experience - Open Source CMS

Thematic API

Thematic pages are customized landing pages that are similar to category pages. The thematic API retrieves these pages for your site visitors. You can learn more about the Thematic Pages feature and how it benefits your site in the Thematic pages article.

JSON or HTML responses?

During integration kickoff, you selected either JSON or HTML responses for your thematic pages. As you work through the thematic API deployment part of your integration process, make sure that you're using the content designed for your responses.

JSON content

Use cases to modify your thematic results:

HTML content

High-level integration steps - JSON

Integration steps

The Bloomreach integration team meets with you to configure your thematic pages. Here are the essential steps thawet you follow with Bloomreach's guidance:

  1. Define the URL pattern for your thematic pages.

  2. Determine how to handle different user agents, such as those for mobile devices and desktops.

  3. Make a server-side API call to the Bloomreach Commerce Organic thematic servers.

  4. Extract the data from the JSON response.

  5. Construct the page for your user by inserting the data into your regular category page template.

Thematic integration checklist

  • Verify that the theme extraction from the incoming URL is correct.

  • Verify that API requests are formed correctly, and that all the required parameters and values are populated.

  • Verify that the raw API calls return valid JSON for a set of example pages.

  • Verify that responses have the right parameters.

  • Verify that responses render correctly.

High-level integration steps - HTML

Integration steps

The Bloomreach integration team meets with you to configure your Thematic Pages. Here are the essential steps that you follow with Bloomreach's guidance:

  1. Define the URL structure for your Thematic Pages.

  2. Determine how to handle different user agents, such as those for mobile devices and desktops.

  3. Create a new page template.

  4. Add a Thematic API call to the new page template. Here's how:

    1. Make a server-side API call to the Bloomreach Organic Thematic servers.

    2. Extract the header widget and Thematic body from the API response.

    3. Insert HTML markup in your page template.

  5. Deploy your thematic XML sitemap.

Thematic integration checklist

  • Verify that the page name extraction from the incoming URL is correct.

  • Verify that API requests are formed correctly and that all the required parameters and values are populated.

  • Verify that the raw API calls return valid HTML for a set of example pages.

  • Verify that a call that returns empty HTML or a failure code causes the failover HTML to be populated.

  • Verify that the header and body are returned and parsed correctly.

  • Verify that the header section contents from the response are in the head section only one time. 

  • Verify that CSS, images, and JavaScript are in the correct directories and have valid permissions.

  • Check the constructed thematic page and review it for errors, especially in its CSS and page structure.

  • Verify that when an invalid thematic page is requested or the request times out, the page is redirected to the homepage with ?_thto=1 appended to the URL. For example: http://www.example.com/?_thto=1

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?