Commerce Services Connector
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 production and sandbox API keys, and specify the data space in the configuration. You only need to configure the connection one time for each instance.
Available services availableservices
The following lists the Commerce features you can access through the Commerce Services Connector:
Architecture
At a high level, the Commerce Services Connector is made up of the following core elements:
The following sections discuss each of these elements in more detail.
Credentials apikey
The production and sandbox API keys are generated from the Commerce account of the license owner. The Commerce account is identified by a unique Commerce ID (MageID). The license owner for the merchant’s organization can generate API keys for services like Product Recommendations or Live Search, as long as the account is in good standing.
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. Developers who have been granted Shared Access by the license owner cannot generate the keys on their behalf even if the merchant’s organization is present in the Switch Accounts dropdown on their account.
Additionally, solution integrators are also entitled to use Commerce Services. If you are a solution integrator, the signer of the Commerce partner contract should generate the API keys.
Generate the production and sandbox API keys genapikey
-
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.
-
Enter a name in the API Keys section, and click Add New to open the dialog to download the new key.
note warning WARNING This dialog provides the only opportunity that you have to copy or download your keys. -
Click Download then click Cancel.
-
Repeat the above steps for each environment (production and sandbox).
The API Keys section now displays your API (Public) keys. You need all four keys (both the production and sandbox keys, Public+Private) when you select or create a SaaS project in any of the environments/installations associated with the license.
SaaS configuration saasenv
Commerce instances must 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 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.
For 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.
If this should happen, submit a Support request to request data cleanup.
SaaS data space provisioning
All Adobe Commerce merchants can access one production data space and two testing data spaces per SaaS project.
You can use the testing data spaces in any non-production environment as long as you don’t use the same data space in multiple environments at the same time. To use the test data space in a different environment, perform a data cleanup before you select and configure the data space in that environment.
For Adobe Commerce Cloud Pro projects with multiple staging environments, you can request additional testing data spaces for each staging environment by submitting a Support request. However, if you only have one staging environment and require additional testing data spaces, you have the following options:
- Contact the Customer Success team or your appointed Customer Success Manager to request an additional Staging environment. There is an additional cost involved.
- Submit a Support request for an additional testing data space and indicate the business justification for the extra dataspace. This request is subject to approval.
Select or create a SaaS project createsaasenv
To select or create a SaaS project, request the Commerce API key from the Commerce license owner for your store:
-
On the Admin sidebar, go to System > Services > Commerce Services Connector.
If you do not see the Commerce Services Connector section in the Commerce configuration, install the Commerce modules for your desired Commerce service. Also, make sure that the
magento/module-services-idpackage is installed. -
In the Sandbox API Keys and Production API Keys sections, paste your key values.
- Private keys must include
----BEGIN PRIVATE KEY---at the beginning of the key and----END PRIVATE KEY----at the end of the key. - If you do not have a copy of the actual keys, ask the Account Owner for them, then plug the values into the configuration.
note warning WARNING If you add key values by querying a database backup or snapshot and pasting the values into the configuration, an additional layer of encryption is applied, and the keys will not work. - Private keys must include
-
Click Save.
Any SaaS projects that are associated with your keys appear in the Project field in the SaaS Identifier section.
- If no SaaS projects exist, click Create Project. Then in the Project field, enter a name for your SaaS project.
- Select the Data Space to use for the current configuration of your Commerce store.
To change the names of your SaaS project or data space, click Rename next to either one. Changing the name does not affect your service because the name is only a label to help you identify and differentiate between projects and data spaces.
IMS Organization (optional) organizationid
To connect your Adobe Commerce instance to the Adobe Experience Platform, sign in to your Adobe account using your Adobe ID. After you sign in, the IMS organization associated with your Adobe account is displayed in this section.
SaaS data export
When your Commerce instance successfully connects to Commerce Services, the SaaS data export process exports Commerce data from your Commerce server to Commerce SaaS Services so it can be synchronized to connected Commerce Services. In the Admin, you can check synchronization status using the Data Management dashboard. For details, see the SaaS Data Export Guide.