Article sections

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

    2. Configure 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 unauthorised access. Please save these credentials to a safe place, you will need to use them later in Reveal.

    3. Use the feeds in Reveal

    You can use these feeds in two places in Reveal:

    • Use the feeds when creating a new shop:
      • Click on Add Shop and follow the configuration wizard until you reach the screen where the feeds are requested.
    • Use the feeds for an existing shop:
      • Go to Store settings -> General -> Edit (in the box labeled Import).
    • Enter the urls requested in the page.

    The feeds will have the following format:

    https://{your_website_path}/omniconvert_reveal/feeds/categories
    https://{your_website_path}/omniconvert_reveal/feeds/products
    https://{your_website_path}/omniconvert_reveal/feeds/customers
    https://{your_website_path}/omniconvert_reveal/feeds/orders

    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: yourdomain.com/shop).

    The interfaces will also prompt you to enter the username and password created at step 2.

    4. Enable RFM Synchronization

    This feature will enable your shop to automatically synchronise 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 URI – should always be: https://api.reveal.omniconvert.com/
      • Unique shop hash – get it from the Reveal Dashboard:
        • Log in to your account and select make sure a shop is selected
        • Find the unique shop hash 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 Configure.
    This image has an empty alt attribute; its file name is image-8-1024x306.png
    • 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.

    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