Magento Services

Some Magento features are deployed as SaaS services. To use these services, you must connect your Magento instance to these services using an API key and specifying the SaaS environment in the Magento configuration.

Magento API key

When you create a Magento account, identified by a MageID, you can generate a Magento API key. To use Magento Commerce SaaS services, such as Product Recommendations, the license-holder must generate the API key in order to pass entitlement validation. This API key can then be passed to the systems integrator or development team that manages the SaaS projects and environments on behalf of the license-holder. If you are a solution integrator, the signer of the Magento partner contract should generate the API key.

Generate an API key

  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.

    Get API Key

  4. With the API key, you can now create a SaaS Environment.

SaaS projects and environments

Magento SaaS services are made up of SaaS projects and environments. SaaS projects and environments are separate but analogous concepts to Magento Cloud projects and environments. A SaaS project is a grouping of SaaS environments. A SaaS environment defines a data space that is used to collect and store data that enables Magento services to work. Some of this data may be exported from Magento and some may be collected from shopper behavior on the storefront. That data is then persisted to secure cloud storage and not to the Magento servers.

In the case of Product Recommendations, the SaaS environment contains catalog and behavioral data. You can point a Magento instance to a SaaS environment by selecting that SaaS environment in the Magento configuration.

The production SaaS environments should be reserved for use with only production sites to avoid data collisions.

SaaS environments are designed to support multiple different websites, identified by their website codes. Data from the same website gets compiled together and separated from data from other websites. This allows you to reuse one SaaS environment by multiple Magento installations, as long as all websites have unique codes specified. Otherwise, you risk overwriting your data for the same website.

When you create a SaaS project, Magento generates one or more SaaS environments depending on whether or not you have a Magento license:

  • Magento Commerce - One production environment; two testing environments

  • Magento Open Source - One production environment; no testing environments

Create SaaS Environment

If you do not see the Magento Services section in the Magento configuration, you need to install the modules by running the following commands: composer require magento/data-services and composer require magento/saas-export. These modules are part of the magento/product-recommendations meta package.

To create a SaaS Environment, request the Magento API key from the Magento license holder for your store.

  1. On the Admin sidebar, go to Stores > Settings > Configuration.

  2. In the left panel, expand Services and choose Magento Services.

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

  4. Click Save Config.

    When you save, if there are any SaaS projects associated with your API key, those projects will appear in the SaaS Project field located in the SaaS Environment section.

  5. If there are not any SaaS projects created, click the Request New Project to display the Project Name field and enter a name for your SaaS project.

    Magento creates a SaaS project and the number of SaaS environments you are entitled to.

  6. Select the SaaS Environment to use for the current configuration of your Magento store.

To change the SaaS project or environment names, click the Rename this Project or Rename this Environment respectively.