Documentation Center

Setting up the Connector for Magento

The setup process for the Tridion Connector for Magento includes adding the Connector itself to your Tridion implementation as well as a few additional steps to enable the integration.

Before you begin

Before beginning the Connector setup process, be sure you have the following:

  • One of the following versions of Magento Commerce:
    • 2.2.x
    • 2.4.x
  • Connector Add-on package provided by SDL Customer Support
  • SDL Tridion Sites 9.1 or later, installed and fully operational
  • If using SDL Tridion Sites 9.1, the following hotfixes are been applied:
    • CM_9.1.0.16685
    • ECL_9.1.0.18607
  • The NET Core Runtime version 3.1 is installed on the host machine of the Content Service and on all Content Manager server machines where the connector will be used. Download the .NET Core Runtime for either Windows or Linux from the following location: https://dotnet.microsoft.com/download/dotnet-core/3.1
  • If using the Connector with Content Delivery, the PCA extension (connector-framework-pca-extension) for the Tridion Integration Framework is installed to the Content Service

About this task

This topic describes the general process for setting up the Connector for Magento.

Procedure

  1. In the Magento Commerce user interface, do the following:
    1. Define an API user that will be a user of the Connector.
      At a minimum, the user needs to have rights to view categories and products in the product catalog.
    2. Activate the use and generate an access token.
      Copy the token, as you will need it in a subsequent step for configuring the Connector.
  2. Upload the Connector for Magento ZIP package to the Add-ons Service.
  3. Create a JSON configuration that includes appropriate settings for this Connector and your environment. In particular, be sure of the following:
    • When the Connector will be accessed through the Tridion Sites Content Manager user interface:
      • The 'sitesCm' property is set to true.
      • The configuration defines the TCM-URI of the stub folder.
    • To use the Connector with Content Delivery, configure the correct environment name (for example 'staging', 'live') and make sure that it is enabled.
  4. Upload the Connector's JSON configuration file to the Add-ons Service.
  5. If using the Connector with Content Manager, go to the user interface and select the Refresh option (or F5).

    The Connector should appear as a new External Content Library (ECL) mount point, as in the following example:

  6. If using the Connector with the Tridion Content Delivery, do the following to complete and verify the Connector setup:
    1. Restart the Content Service.
      The Content Service should automatically pick up the Connector package and configuration from the Add-ons Service and deploy the Connector.
    2. Open the GraphQL console at [Content Service URL]/cd/api/graphiql and verify the presence of appropriate GraphQL types for this Connector.