This documentation is for the Product Recommendations Early Access Program. If you would like to participate, E-mail us!

Configure Recommendations

After you install the product-recommendations module, you must configure the catalog SaaS export module, set the environment, and specify the SaaS Environment ID.

Configure the Catalog SaaS Export module

The Catalog SaaS Export module allows you to access your store’s catalog data. You create a link to that data using an API key.

The Catalog SaaS Export module is a requirement to successfully use the Product Recommendations JS SDK. This module requires Magento 2.3 or later.

Generate an API key

To ensure the MageID and API key are linked, the user whose MageID was provided at sign-up needs to be the same user who generates the API key. If you must change the MageID that was used, E-mail us.

  1. Log in to your Magento account at https://account.magento.com.

  2. Under the Magento tab, select API Portal on the sidebar.

  3. Generate and copy the API key for Production.

    Generate API key

  4. In the Magento Admin, choose Stores > Settings > Configuration > Services > Magento Services.

  5. In the API Keys section, paste your key value into the Production Api Key field regardless of whether you are in a production environment or non-production environment.

    Set API key

Configure your environment

You must configure your environment to ensure the data being collected is coming from a production storefront rather than a storefront under test.

  1. On the Admin sidebar, choose Stores > Settings > Configuration > Services > Magento Services.

  2. Expand the Services ID section.

  3. In the Environment drop-down, select either Testing or Production. The Instance ID field is auto-populated. Do not remove this ID.

Enter your SaaS Environment ID

  1. On the Admin sidebar, choose Stores > Settings > Configuration > Services > Magento Services.

  2. Expand the Services ID section.

  3. In the SaaS Environment ID field, enter the SaaS Environment ID you received after signing up. If you did not receive your ID, E-mail us.