Emporix Storyblok App

Learn about integration possible with the Emporix Storyblok app.

Emporix partners with Storyblok which is a headless CMS that combines developer flexibility with an intuitive visual editor, making it easy to create and deliver content across any digital platform. The integration between Emporix and Storyblok is established with the field plugin. This plugin connects to the Emporix Commerce API to retrieve products and categories that are later displayed for the customers.

The key features are:

  • Product Search – finding products by name

  • Category Filtering – narrowing search results by category

When adding items to the story through the field plugin, you can browse through products and categories using either a list view or grid:

If you want to filter the results, you can narrow the search by categories:

Configuration

The Storyblok integration setup requires different steps that need to be combined between the customer and Emporix support team.

Preparation steps

To start your integration between Storyblok and Emporix, as a customer go through the following steps:

1

Add Emporix user to your Storyblok account

Log in to your Storyblok account and add support@emporix.com as a user.

To learn how to add a new user, see the Adding new team members Storyblok documentation.

2

Contact Emporix about the integration

Inform the Emporix Support Team that support@emporix.com has been added as a user to your Storyblok account.

Once notified, the Emporix team completes the installation steps on their side. After the installation is finished, the Emporix Support Team will notify you about the completion.

3

Remove the Emporix user

When the previous steps are done, you can remove support@emporix.com from your Storyblok account. Then, continue with the next steps to configure the field plugin.

Field plugin configuration

The Storyblok field plugin requires the following details to connect to the Emporix API:

  • tenant - Your Emporix tenant identifier

  • clientId - Client ID for API authentication

  • clientSecret - Client secret for API authentication

  • baseUrl - Emporix API base URL, the default is https://api.emporix.io

You can find all the data in your Emporix developer portal in the Manage API Keys section.

When you have the data, these values are configured using Storyblok UI when adding the field plugin in Storyblok:

1

Create a new field plugin

Go to the field plugin design in your Storyblok account.

2

Define values in the field configuration

Enter the tenant, clientID, clientSecret and baseUrl values as Options in the Settings section.

3

Add the items

When the values are defined, use the Add items in the Preview block within the field plugin UI editor and select the products or categories that you want to have displayed. When you select the products for your story, they are later visible in the preview list:

4

Save the story

After you save the story, you can review it and check if everything is displayed correctly.

Last updated

Was this helpful?