Skip to main content

Integration Steps for Magento 2 – 3.x/2.x (Older Versions)

Updated
For sites using the latest Magento version (2.4.4 and above), please follow this link for Klevu module version 4.x. For older Magento versions, refer to the document below.

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 the 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.

Sometimes, if you install an extension you purchased from Magento Marketplace, you may notice the latest Klevu release is not available from Magento Marketplace.

Magento Marketplace reviews each and every update we submit to them carefully. Thus, it can take up to 4-6 weeks until an update we submit to Magento Marketplace is released and can be installed by you. This causes the delay - you can see a newer version is available, but not on Marketplace, as the Marketplace QA team is still reviewing the update.

In this situation, you can instruct Composer to install the Klevu modules via Packagist instead by adding "exclude": ["klevu/*"] to the ' https://repo.magento.com/' repository in your composer.json file

"repositories": [
    {
        "type": "composer",
        "url": "https://repo.magento.com/",
        "exclude": ["klevu/*"]
    }
]

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 the 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. 
    To do so, please contact our support team. 
  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 the section below

Configure the extension:

  1. Go to Magento 2 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 the search on your store.

 

 

Related articles

Powered by Zendesk