Getting Started

This guide gets you up and running with Kiyoh Reviews in just a few minutes. You'll connect your Kiyoh account, import your first reviews, and display them on your store.

Before You Begin

Make sure you have:

• Active Kiyoh account with API credentials
• Magento 2.3.x or 2.4.x installation
• Admin access to your Magento store

Step 1: Add Your Account

1. Go to Marketing → Kiyoh → Accounts
2. Click Add New Account
3. Enter your Kiyoh credentials:
   • Name: A friendly name for this account (e.g., "Main Store")
   • API Key: From your Kiyoh dashboard
   • Location ID: Your shop identifier in Kiyoh
4. Click Save
5. The connection status will show "Connected" if successful

Step 2: Enable the Extension

1. Go to Stores → Configuration → Magmodules → Kiyoh
2. In the General section:
   • Set Enabled to "Yes"
3. In the Accounts section:
   • Select your account(s) to use
   • Choose the locale (language) for reviews to display
4. Click Save Config

Step 3: Import Reviews

Reviews are imported automatically via cron, but you can trigger the first import manually:

Option A: Via Admin

• Go to Marketing → Kiyoh → Reviews
• Click Sync Reviews button

Option B: Via CLI

bin/magento shopreview:kiyoh:sync --all

Step 4: Display Reviews

Enable the Review Page

Add a Widget

Step 5: Set Up Invitations (Optional)

To automatically send review invitations after orders:

1. Go to Marketing → Kiyoh → Accounts
2. Edit your account
3. In the Invitation Profile section:
   • Enable invitations
   • Set the delay (days after order)
   • Select which order statuses trigger invitations
   • Choose customer groups to include
4. Save

Verify Everything Works

Run the self-test to check your configuration:

bin/magento shopreview:kiyoh:selftest

This checks:

• Extension is enabled
• Account credentials are valid
• API connection works
• Cron is configured

Next Steps

• Configuration Guide - Detailed settings reference
• Widget Setup - All 8 widget types explained
• Best Practices - Tips for optimal setup

Need More Help?

Documentation:

• All Help Articles - Complete documentation overview

Support:

• Contact Us - Get help from our team