Article sections

    Install the Magento 2 module

    • Download and extract the archive containing the module.
    • Copy the folder named Omniconvert from the extracted archive into the app/code folder of your magento installation.
    • Run the following commands in order to enable the module:
    php bin/magento module:enable Omniconvert_Reveal
    bin/magento setup:upgrade
    bin/magento cache:clean
    • In order to generate the feeds manually run this command (the feeds will be regenerated every night automatically):
    bin/magento reveal:export

    —> Configuring the Magento 2 module

    Access your admin page and go to Stores -> Configuration in the left menu.

    Go to Omniconvert Reveal -> Feed credentials option in the menu and choose a username and password that will protect your feeds from unauthorized access. Please save these credentials to a safe place, you will need to use them later in Reveal.

    Now, let’s set-up the Reveal account:

    Installing Reveal as a Custom/Magento Shop

    After creating the feeds the following steps should be followed:

    Step 1 – create a new Reveal account  

    Step 2 – create a new shop

    from the Side Menu, select “Add Shop”, fill in the new shop domain and name it, then click “Save”

    Step 3 – Start the integration

    Step 4 – Use the feeds in Reveal

    Click on “Start Custom Connect” and follow the configuration wizard until you reach the screen where the feeds are requested.

    The feeds will need to have the following format:


    You will need to replace {your_website_path} with the domain of your website and optionally the path (if your website is not hosted on a domain or subdomain directly and it’s hosted in a folder, for example:

    The interfaces will also prompt you to enter the username and password created when configuring the Magento 2 module.

    Step 5 – Enable RFM Synchronization in Magento account

    This feature will enable your shop to automatically synchronize the RFM information directly from Reveal. The information will be saved on the customer as custom attributes on your Magento 2 installation.

    • Go back to your admin panel and access your admin page and go to Stores -> Configuration in the left menu.
    • Click on the RFM Sync button and select Yes from the Enable Module dropdown.
    • Fill in the rest of the information:
      • API URL – should always be:
      • Unique shop hash(ID) – get it from the Reveal Dashboard:
        • Log in to your account and make sure your shop is selected
        • Find the unique shop hash (ID) in the URL in your browser, like in the example below:
    This image has an empty alt attribute; its file name is image-7-1024x267.png
    • Username – your Reveal email address.
    • Key – Generate an API key in the Reveal interface:
      • Go to Store Settings > General.
      • Scroll down to Access Control section and click on the pencil button to Configure the settings:
    • Click on Add new API Key and follow the wizard to create a new key.
    • Copy the newly created key to your Magento 2 admin panel.

    Now, after your historical data import is done and all that remains for you to do is to enable the daily import. For that you will have to access the Store Settings > General, go inside the Imports section and make sure the toggle with the Daily Enabled is on, then Save all the edits:

    That’s it! You are now all set!

    Additional details needed?

    Please don’t hesitate to reach out to our amazing customer support team if you need any additional information.

    Was this post helpful?

    Related Articles