Adobe Commerce
Adobe Commerce (opens in a new tab) (formerly Magento) is an open-source e-commerce platform that enables businesses to build and manage online storefronts, product catalogs, customer accounts, orders, and carts.
Prerequisites
This connector supports self-hosted Adobe Commerce (PaaS) instances. Adobe Commerce Cloud SaaS (fully managed by Adobe) uses a different authentication model and is not supported by this integration.
In order to integrate with Adobe Commerce, you'll need to collect the following information:
| Name | Description |
|---|---|
| Domain* | The hostname of your Adobe Commerce instance (e.g. store.example.com). |
| Consumer Key* | The OAuth1 consumer key generated by an Adobe Commerce Integration. |
| Consumer Secret* | The OAuth1 consumer secret generated by an Adobe Commerce Integration. |
| Access Token* | The OAuth1 access token generated by an Adobe Commerce Integration. |
| Access Token Secret* | The OAuth1 access token secret generated by an Adobe Commerce Integration. |
Obtaining OAuth credentials
Adobe Commerce uses OAuth 1.0a for API authentication. Credentials are generated by creating an Integration in the Adobe Commerce Admin:
- Log into your Adobe Commerce Admin panel and navigate to System → Extensions → Integrations.
- Click Add New Integration and provide a name (e.g.
Fides). - Select the API tab and grant access to the following resource scopes: Customers, Orders, and Carts.
- Click Save, then click Activate next to your new integration.
- Adobe Commerce will display all four OAuth credentials — Consumer Key, Consumer Secret, Access Token, and Access Token Secret.
The Consumer Secret, Access Token, and Access Token Secret are displayed only once upon activation. Copy and store all four values securely before closing the dialog, as they cannot be retrieved again.
Integrating with Adobe Commerce
To integrate an existing system with Adobe Commerce:
- Navigate to Data map → View Systems and choose the system that you want to connect.
- Click on the Integrations tab.
- Pick the vendor or system type that you want to integrate with from the Connection type drop-down menu.
- Complete the required fields (Domain, Consumer Key, Consumer Secret, Access Token, Access Token Secret) and click Save.
You may confirm your integration is working using the Test connection button, if desired.
To learn more, please see our guide for Managing Integrations.
Technical detail
Fides utilizes API endpoints to access the API service for a SaaS application. An API service is the programmatic interface through which Fides can query and update data within an application to access, rectify, or delete personal information. Each SaaS tool will have a unique set of endpoints to enable privacy functions.
Adobe Commerce endpoints
In the table below, you can find which endpoints are used for each type of privacy function.
| Privacy function | Endpoint | Description |
|---|---|---|
| Access Requests | Customer Search (opens in a new tab) | Searches for a customer record matching the provided email address. |
| Access Requests | Customer Addresses (opens in a new tab) | Retrieves individual address records linked to the customer. |
| Access Requests | Customer Shipping Address (opens in a new tab) | Retrieves the customer's default shipping address. |
| Access Requests | Orders (opens in a new tab) | Retrieves orders associated with the customer's email address. |
| Access Requests | Carts (opens in a new tab) | Retrieves cart data associated with the customer's email address. |