Open navigation

Integration Steps for Magento 2

Installing the Extension:

Version 3.x - Compatible with Magento 2.3+

There are three methods to install the Klevu Search extension:

1. Via Composer (recommended):

composer require klevu/module-search

For Magento 2.3, you will also require the klevu/module-mysqlcompat module. This is not required for Magento 2.4

composer require klevu/module-mysqlcompat

If the website is using Inventory Management (aka MSI), please execute the below composer command to install Klevu MSI compatible module.

composer require klevu/module-msi

Then for all Magento versions, complete the following steps:

composer require klevu/module-search
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

2. Via Manual Download:

We do not recommend installing the Klevu module by manually downloading it and putting it into the app/code directory. Please contact Klevu support if you still wish to use this method to install the module.

3. Via Magento Marketplace:

Please go to Magento Marketplace and get the extension, after you get the extension, there will be further instructions for installing it.

Version 2.x - Compatible with Magento 2.1+

For Magento 2.4 and above, we've introduced a backward compatibility module to our extension, so there are new steps required for installing and upgrading Klevu Search. Please carefully follow the instructions below.

There are two methods to install the Klevu Search extension:

1. Via Composer (recommended):

For Magento 2.4+, before running composer require, please modify your project composer.json to remove the module we've introduced for backward compatibility. Do not add this 'replace' for Magento 2.3 or lower.

  "require": {
...
},
"replace": {
"klevu/module-mysqlcompat": "*"
}

If the website is using Inventory Management (aka MSI), please execute the below composer command to install Klevu MSI compatible module.

composer require klevu/module-msi

Then for all Magento versions, complete the following steps:

composer require klevu/module-search
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
If you find that composer is trying to install a very old version of Klevu, or errors relating to public vs private repositories, this may be due to a recent Magento update where composer will prefer the Magento Marketplace repository. You can override this by amending your composer.json with an exclude as follows:
"repositories": [
{
"type": "composer",
"url": "https://repo.magento.com/",
"exclude": ["klevu/*"]
}
]

2. Via Manual Download:

We do not recommend installing the Klevu module by manually downloading it and putting it into the app/code directory. Please contact Klevu support if you still wish to use this method to install the module.

Create a New Klevu Account:

  1. You will need a Klevu account to connect your Magento store with Klevu. Sign up for a free access and setup your Klevu account by following on-screen instructions
    1. Please select the Klevu solutions (Smart Search, Smart Category Merchandising & Smart Recommendations) and provide your business information while setting up your Klevu account
  2. Once your account is set up and activated, please add a new store by providing the necessary details
  3. An API Key & REST AUTH Key will be generated. Please copy these keys for later use
  4. Configure the Klevu extension by following the steps given in below section

Configure the extension:

  1. Go to Magento2 Admin Panel
  2. Go to Stores → Configuration
  3. Go to Klevu → Integration
  4. Scroll down to see Klevu Integration Status
  5. For the website that you wish to integrate Klevu, click on the respective Integrate Now link. This will change the store scope and you will land on the following screen.
  6. Paste the copied API Key & REST AUTH Key from Klevu Merchant Center.
  7. Click on Check API Keys, review the details & click on Confirm and Integrate.
  8. Once the Integration is complete, click on Sync Catalog Data and then enable Klevu solutions.
  9. Once you are done, please allow 10-15 minutes before trying out search on your store.



Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.