Some Adobe Commerce and Magento Open Source features are powered by Commerce Services and deployed as SaaS (software as a service). To use these services, you must connect your Commerce instance using an API key and a private key, and specify the data space in the configuration. You only need to set this up once.
The following lists the Commerce features you can access through the Commerce Services Connector:
|Product Recommendations powered by Adobe Sensei||Adobe Commerce|
|Live Search powered by Adobe Sensei||Adobe Commerce|
|Payment Services||Adobe Commerce and Magento Open Source|
|Channel Manager||Adobe Commerce and Magento Open Source|
At a high level, the Commerce Services Connector is made up of the following core elements:
Commerce Services Connector Architecture
The following sections discuss each of these elements in more detail.
The API key and private key are generated from the Commerce account of the license holder, which is identified by a unique Commerce ID (MageID). To pass entitlement validation for services such as Product Recommendations or Live Search, either the license holder or a trusted individual with shared access to the account must generate the set of keys. The keys can be shared on a “need to know” basis with the systems integrator or development team that manages projects and environments on behalf of the license holder. If you are a solution integrator, the signer of the Commerce partner contract should generate the keys.
Generate an API key and private key
Log in to your Commerce account at https://account.magento.com.
Under the Magento tab, select API Portal on the sidebar.
From the Environment menu, select Production or Sandbox.
For Product Recommendations and Live Search, select Production. Production keys give you access to production and non-production data spaces. Sandbox keys are not used for these services.
Enter a name in the API Keys section and click Add New.
This opens a dialog for downloading the new key.
Download private key
This is the only opportunity you will have to copy or download your key.
Click Download then click Cancel.
The API Keys section now displays your API key. You will need both the API key and private key when you select or create a SaaS project.
Commerce instances need to be configured with a SaaS Project and a SaaS Data Space so that Commerce Services can send data to the right location. A SaaS Project groups all of the SaaS Data Spaces. The SaaS Data Spaces are used to collect and store data that enables Commerce Services to work. Some of this data may be exported from the Commerce instance and some may be collected from shopper behavior on the storefront. That data is then persisted to secure cloud storage.
In the case of Product Recommendations, the SaaS data space contains catalog and behavioral data. You can point a Commerce instance to a SaaS data space by selecting it in the Commerce configuration.
You should use your production SaaS data space only on your production Commerce installation to avoid data collisions. Otherwise, you risk polluting your production site data with testing data, which will cause deployment delays. For example, your production product data could be mistakenly overwritten from staging data, such as staging URLs.
Select or create a SaaS project
If you do not see the Commerce Services Connector section in the Commerce configuration, you need to install the Commerce modules for your desired Commerce Service, such as Product Recommendations.
To select or create a SaaS project, request the Commerce API key from the Commerce license holder for your store.
On the Admin sidebar, go to Stores > Settings > Configuration.
In the left panel, expand Services and choose Commerce Services Connector.
In the API Keys section, paste your key values for the Production API Key and the Production Private Key.
Private keys must include
----BEGIN PRIVATE KEY---at the beginning of the key and
----END PRIVATE KEY----at the end of the private key.
Click Save Config.
Any SaaS projects that are associated with your API key appear in the SaaS Project field.
If no SaaS projects exist, click Create Project. Then in the Project Name field, enter a name for your SaaS project.
When you create a SaaS project, Commerce generates one or more SaaS data spaces depending on your Commerce license:
- Adobe Commerce - One production data space; two testing data spaces
- Magento Open Source - One production data space; no testing data spaces
Select the SaaS Data Space to use for the current configuration of your Commerce store.
If you generate new keys in the API Portal section of My Account, immediately update the API keys in the Admin configuration. If you generate new keys and do not update them in the Admin, your SaaS extensions will no longer work and you will lose valuable data.
To change the SaaS project or data space names, click the Rename this Project or Rename Data Space respectively.
When your Commerce instance successfully connects to Commerce Services, the catalog sync process exports product data from your Commerce server to Commerce Services. Learn more about the catalog sync process.