Adobe Ecommerce (Magento)

Adobe Commerce, formerly known as Magento Commerce, is a premium, enterprise-level eCommerce platform that helps businesses create personalized shopping experiences.

Magento versions currently supported by Relyance are 1.9.x and 2.4.x

In order to integrate Magento with Relyance AI you will need:

• Consumer Key; Consumer Secret; Consumer Username; Consumer Password (For Magento 1.9.x)
• Consumer Key; Consumer Secret; Access Token; Access Token Secret (For Magento 2.4.x)

In Magento (2.4.x):

1. Login to your magento account.
2. Navigate to System(sidebar gear icon) > Extension > Integration (subitem)
3. In the Integration info screen, only add in the Integration name and your password
4. In the API screen, select teh following resources: Sales, Operations, Orders, Actions,, Shipments, Customers, All Customers, Carts, Manage Carts
   • Please make sure that "Delete" is also selected explicitly as shown in the screenshot below:
5. Activate the integration
6. Once you activate it, you will receive the credential information. Note this information down

In the Relyance AI application:

1. Login to your Relyance account.
2. Navigate to the Settings (bottom-left corner).
3. Select Integrations.
4. Search and locate the Magento integration card and click on it.
5. Click on the Add Connection button on the top right .
6. Provide a meaningful name for the integration and click on the Add button
7. In the Overview section, select the integration features you wish to enable for the integration, review the Scope and Permission, and Endpoint details and click on Continue. For more details, see Integration Features

8. In the Connection section, provide the appropriate values and click on Continue,

9. The Authentication section, provides two modes of authentication

   • OAuth - Add your Magento host name (the full URL without https:// ). Paste the Consumer Key, Consumer Secret, Consumer Username, and Consumer Password you had received from Magento into Relyance

   

   • Adobe Commerce OAuth - Add your Magento host name (the full URL without https:// ). Paste the Consumer Key, Consumer Secret, Access Token, and Access Token secret you had received from Magento into Relyance

   

10. If the Data Inspection check box is checked from step 7, Minimum Confidence Level: This property adjusts the sensitivity of the Data Inspection feature. Lower likelihoods (e.g., unlikely) offer more coverage but may produce false positives, while higher sensitivity (e.g., very likely) provides greater accuracy but less coverage.

    • In the Data Inspection section, provide the appropriate values and click on Continue,

11. Review the configuration summary from the Completion section and click on Finish.

12. Confirm the integration Status reflects Connected

If the connection reports Connected but returns nothing

These are the ways this integration comes back empty without reporting an error. Generated from the integration catalog, so it tracks what the connection actually asks for.

1. A feature you enabled returns nothing. Some scopes belong to a feature rather than to the connection: Data subject requests needs Role Attribute: Customer - Retrieve, Role Attribute: Customer - Delete, Role Attribute: Customer Address - Retrieve, Role Attribute: Customer Address - Delete, Role Attribute: Orders - Retrieve, Magento_Sales::create. Turning the feature on after the connection exists does not widen the grant it already holds, so re-authenticate the connection.
2. A credential rotated at the vendor is not picked up here. Consumer Key, Consumer Secret, Consumer Password and 2 more are stored when you save the connection, so regenerating the value at the vendor breaks the next scan until it is re-pasted here. Recording the expiry on the connection means Relyance warns you before it lapses.
3. Check the address fields before suspecting the credentials. Host identifies which tenant, region or host to talk to. A wrong value there fails authentication and looks exactly like a bad secret.

Manage this integration with Terraform

Connections for this integration can be managed as code with the Relyance Terraform provider. Non-secret fields go in auth.params; secret fields go in auth.secrets_wo, which is write-only — never stored in Terraform state. Rotate secrets by bumping auth.secrets_wo_version.

Username & password

resource "relyance_integration_connection" "adobe_magento_0" {
  vendor = "adobe_magento"
  name   = "<your connection name>"

  auth = {
    method = "username-password"
    params = {
      host = "<host>"
      consumer_username = "<consumer_username>"
      data_storage_location = "us"
    }
    # Secret fields are write-only: sent to Relyance, never stored in state.
    secrets_wo = {
      consumer_key = var.adobe_magento_consumer_key
      consumer_secret = var.adobe_magento_consumer_secret
      consumer_password = var.adobe_magento_consumer_password
    }
    secrets_wo_version = 1
  }

  scans = { "data-inspection" = { enabled = true } }
}

Access token

resource "relyance_integration_connection" "adobe_magento_1" {
  vendor = "adobe_magento"
  name   = "<your connection name>"

  auth = {
    method = "access-token"
    params = {
      host = "<host>"
      data_storage_location = "us"
    }
    # Secret fields are write-only: sent to Relyance, never stored in state.
    secrets_wo = {
      consumer_key = var.adobe_magento_consumer_key
      consumer_secret = var.adobe_magento_consumer_secret
      access_token = var.adobe_magento_access_token
      access_token_secret = var.adobe_magento_access_token_secret
    }
    secrets_wo_version = 1
  }

  scans = { "data-inspection" = { enabled = true } }
}