Edit in GitHubLog an issue

Rest overview

The Adobe Commerce as a Cloud Service REST API serves as a critical tool for extending and integrating commerce functionalities, but the endpoints available differ significantly from the REST APIs for Adobe Commerce on Cloud and on-premises deployments.

The following key differences are important to consider when planning your REST API integrations with Adobe Commerce as a Cloud Service:

Endpoints

Primarily the Cloud Service REST API differs in that it includes a smaller subset of endpoints. Specifically, the Guest and Customer REST APIs that are available in Adobe Commerce on Cloud and on-premises deployments are not available in Adobe Commerce as a Cloud Service. However, access to similar functionality remains available in the GraphQL API.

For more information on what endpoints are available, refer to the API reference.

Authentication

In previous versions of Adobe Commerce, you would use authentication tokens to authorize your requests to the REST API. In Adobe Commerce as a Cloud Service, you must use Adobe Identity Management Service (IMS) to authenticate your requests.

The authentication system supports both interactive user-based workflows and automated server-to-server integrations, ensuring secure and appropriate access for different use cases. Both of these authentication methods require every request to be signed with an IMS Access Token. For a practical implementation guide with code examples for server-to-server integration, see our Server-to-Server Integration Guide.

URL structure

The URL structure for your REST endpoints will be slightly different in Adobe Commerce as a Cloud Service. In addition to your base URL changing, /rest is no longer needed.

Cloud Service URLs use the following format:

https://<server>.api.commerce.adobe.com/<tenant-id>/<endpoint>

Extensibility

Adobe Commerce as a Cloud Service is highly extensible and is designed to be used with the following extensibility tools. Additionally, because the Cloud Service is preconfigured, you do not need to install any additional composer packages.

Starter kits

Integrations with Adobe Commerce as a Cloud Service rely on IMS integration, which means in your .env file, you need to use Option 2 for authentication as described in env.dist:

Copied to your clipboard
# Option 2: Authenticate with IMS
OAUTH_CLIENT_ID=
OAUTH_CLIENT_SECRETS=[""]
OAUTH_TECHNICAL_ACCOUNT_ID=
OAUTH_TECHNICAL_ACCOUNT_EMAIL=
OAUTH_IMS_ORG_ID=

Events and webhooks

Events and webhooks work slightly differently compared to other versions of Adobe Commerce.

Addtionally, because Adobe Commerce as a Cloud Service is preconfigured with extensibility in mind, you do not need to add or configure the integration in the Adobe Commerce Admin.

Events

  • Events - Adobe Commerce as a Cloud Service supports a different set of events than other versions.

To browse, search for, or request events, navigate to System > Events > Event List in the Admin.

The following REST endpoints are available for events:

  • POST /V1/eventing/eventSubscribe/:name - Subscribes to the event.
  • POST /V1/eventing/eventUnsubscribe/:name - Unsubscribes from the event.
  • GET /V1/eventing/getEventProviders - Lists event providers.
  • GET /V1/eventing/getEventSubscriptions - Lists event subscriptions.
  • PUT /V1/eventing/updateConfiguration - Updates eventing configuration.

Webhooks

Registering webhooks works differently between platforms. Instead of using the webhooks.xml file, you can register webhooks in the Commerce Admin or by using the REST API.

To browse, search, or request webhooks, navigate to System > Webhooks > Webhook List in the Admin.

The following REST endpoints are available for webhooks:

  • GET /V1/webhooks/list - Lists configured webhooks.
  • POST /V1/webhooks/subscribe - Subscribes to a webhook.
  • POST /V1/webhooks/unsubscribe - Unsubscribes from a webhook.
Was this helpful?