Getting started with AEM Commerce as a Cloud Service

To get started with AEM Commerce as a Cloud Service, your Experience Manager Cloud Service needs to be provisioned with the Commerce Integration Framework (CIF) add-on. The CIF add-on is an additional module on top of AEM Sites as a Cloud Service.

Onboarding

The onboarding for AEM Commerce as a Cloud Service is a two-step process:

  1. Get AEM Commerce as a Cloud Service enabled and the CIF add-on provisioned
  2. Connect AEM Commerce as a Cloud Service with your Magento environment

The first step is done by Adobe. You will need to provide information such as the IMS organization, the GraphQL endpoint URL of your Magento environment, etc. as part of the provisioning process. For more details on pricing and provisioning, you need to reach out to your sales representative.

Once you have been provisioned with the CIF add-on, it will be applied to any existing Cloud Manager programs. In case, you don’t have a Cloud Manager Program, you will need to create a new one. For more details, refer to Setup your Program.

The second step is self-service for each AEM as a Cloud Service environment. There are some additional configurations you will need to do after the initial provisioning of the CIF add-on.

Connecting AEM Commerce with Magento

To connect the CIF add-on & the AEM CIF Core Components with you Magento environment you need to provide the Magento GraphQL endpoint URL via a Cloud Manager environment variable. The variable name is COMMERCE_ENDPOINT. A secure connection via HTTPS must be configured.
A different Magento GraphQL endpoint URL can be used for each AEM as a Cloud Service environment. That way projects can connect AEM staging environments with Magento staging systems and AEM production environment to a Magento production system. That Magento GraphQL endpoint must be publicly available, private VPN or local connections are not supported.

To connect AEM Commerce with Magento follow these steps:

  1. Get the Adobe I/O CLI with the Cloud Manager plugin

    Check the Adobe Cloud Manager documenation on how to download, setup and use the Adobe I/O CLI with the Cloud Manager CLI plugin.

  2. Authenticate the CLI with the AEM as a Cloud Service program

  3. Set the COMMERCE_ENDPOINT variable in Cloud Manager

    aio cloudmanager:set-environment-variables ENVIRONMENT_ID --variable COMMERCE_ENDPOINT "<Magento GraphQL endpoint URL>"

    See CLI docs for details.

    The Magento GraphQL endpoint URL must point to Magento’s GraphQl service and use a secure HTTPS connection. For example: https://demo.magentosite.cloud/graphql.

TIP

You can list all Cloud Manager variables using the following command to double-check: aio cloudmanager:list-environment-variables ENVIRONMENT_ID

NOTE

Alternatively you can use the Cloud Manger API to configure the Cloud Manager variables as well.

With this, you are ready to use AEM Commerce as a Cloud Service and can deploy your project via Cloud Manager.

Enable Staged Catalog Features (Optional)

NOTE

This feature is only available with Magento Enterprise Edition or Magento Cloud.

  1. Login to Magento and create an integration token. See Token-based authentication for details. Make sure the integration token has only access to Content -> Staging resources. Copy the Access Token value.

  2. Set the COMMERCE_AUTH_HEADER secret variable in Cloud Manager:

    aio cloudmanager:set-environment-variables ENVIRONMENT_ID --secret COMMERCE_AUTH_HEADER "Authorization Bearer: <Access Token>"

    Please see Connecting AEM Commerce with Magento on how to configure the Adobe I/O CLI for Cloud Manager.

3rd party commerce integrations

For 3rd party commerce integrations, an API mapping layer is needed to connect AEM Commerce as a Cloud Service and CIF Core Components with your commerce system. This API mapping layer is typically deployed on Adobe I/O Runtime. Contact your sales representative for available integrations and access to Adobe I/O Runtime.

On this page