Quick Start Guide

This is the quick start guide for eKomi Reviews. We'll get you up and running in about 5 minutes. This covers the essentials: connecting your eKomi account, importing your first reviews, and displaying them on your store. If you're new to eKomi integration or just want to get started quickly, you're in the right place.

Get eKomi Reviews running in 5 minutes.

Prerequisites

• Module installed and enabled
• Cache cleared after installation
• eKomi account with Interface ID and Interface Password (find these in your eKomi dashboard under Interface Settings)

Step 1: Add Your eKomi Account

Navigate to: Marketing → eKomi → Manage Accounts

Click Add New Account and enter:

• Interface ID: Your eKomi interface ID
• Interface Password: Your eKomi interface password

Save the account. The extension will automatically fetch your shop details and review statistics from eKomi.

Step 2: Enable the Extension

Navigate to: Stores → Configuration → Magmodules → eKomi Reviews

In the General section:

• Set Enabled to Yes

In the Accounts section:

• Select your newly added account(s) in the Accounts field
• Choose your Default Locale (the language of reviews to display)
• Set your Rating Scale (typically 1-5 stars)

Save the configuration and clear cache.

Step 3: Configure Review Import

In the Import section:

• Auto Approve Reviews: Set to Yes if you want reviews to appear immediately, or No to manually approve each review
• Update Frequency: Select how often to sync reviews (recommended: Every Hour)

Reviews will now import automatically via cron. To import immediately, run:

bin/magento shopreview:ekomi:sync --all

Step 4: Display Reviews on Your Store

You have two options:

Option A: Enable the Review Page

In the Frontend section:

• Set Enable to Yes
• Configure Meta Title and Meta Description for SEO
• Enable Google Structured Data for rich snippets

Your reviews will be available at: https://yourstore.com/ekomi/

Option B: Add a Widget

Navigate to: Content → Widgets → Add Widget

Select one of the eKomi widget types:

• eKomi Review Widget: Shows reviews in sidebar, small, or custom layouts
• eKomi Slider Widget: Carousel display with autoplay options

Configure the widget display options and assign it to your desired pages/positions.

Step 5: Verify It's Working

1. Check the review overview page (if enabled): https://yourstore.com/ekomi/
2. Verify reviews appear in Marketing → eKomi → Reviews
3. Check that your account shows review statistics in Marketing → eKomi → Manage Accounts

If reviews aren't showing, run the self-test:

bin/magento shopreview:ekomi:selftest

Need More Help?

Documentation:

• All Help Articles - Complete documentation overview

Support:

• Contact Support - Get help from our team