Magento / Adobe Commerce (TMS)

Content is machine translated from English by Phrase Language AI.


This integration will be deprecated as of December 15, 2023. If requiring an alternate solution, communicate with your Customer Service Manager and consider either a custom solution or using an API.

Magento connector allows the downloading of source content and uploading of translations to/from Magento for the following content types:

  • Products

  • Categories

  • Pages

  • Blocks

Supported Versions

  • Magento CE 2.3 and 2.4

  • Adobe Commerce 2.3 and 2.4 (including on cloud version)

Use Cases

There are a number of use cases for the connector:

  • Project managers can add files directly to projects from an online repository.

  • Set up the submitter portal to allow Submitters to add files to requests directly from the online repository.

  • Use automated project creation (APC) to have new projects automatically created when a change in the last modified date is detected for monitored files or a folder.

    • Selected files are imported the very first time APC runs.

Install Magento Extension

There are three ways to install the Phrase Connector extension into a Magento instance:

Installing via Magento Marketplace

  1. Open the Magento Marketplace entry and add it to cart.

  2. In the Magento Administration, go to System and click on Web Setup Wizard.

  3. Choose the Extension Manager.

  4. Under the number of extensions to install, click on Review and Install.

  5. Find the Phrase Connector, and click on the Install link.

  6. Finish the installation.

For more information, see Magento Documentation.

Installing via Composer

Use the following commands to install via Composer:

composer require phrase/magento2-connector
php bin/magento module:enable Phrase_Connector
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy

Manual Installation

If unable to use either Magento Marketplace or Composer, the connector can be installed manually.

To install manually, follow these steps:

  1. Download the zip file from GitHub releases.

  2. In the Magento installation, extract the downloaded zip file into the folder app/code/Phrase/Connector

  3. Enable the extension and clear the cache with these commands:

    php bin/magento module:enable Phrase_Connector
    php bin/magento setup:upgrade
    php bin/magento cache:flush
    php bin/magento setup:di:compile
    php bin/magento setup:static-content:deploy

Magento Settings

To enter the Magento site without basic authorization, the connector needs to be enabled.

  1. In the Magento Administration, go to Stores and click on All Stores.

  2. Click Create Store View to create a separate view for every language.

  3. To associate language with a store go to Stores and click Configuration, select the Store View from the dropdown menu, and update the Locale Options.

  4. Save the configuration.

  5. Go to Stores, click on Configuration, and select PHRASE.

  6. Copy the URL in the browser address bar and the Token from the General Configuration section.

Phrase TMS Settings

  1. From the Settings Setup_gear.png page, scroll down to the Integrations section.

  2. Click on Connectors.

    The Connectors page opens.

  3. Click New.

    The Create page opens.

  4. Provide a name for the connection and change the Type to Magento .

  5. Enter the Magento site URL (including the protocol) and the Phrase plugin token.

  6. Click Test connection.

    A checkmark will appear if the connection was successful. A red exclamation point will appear if it wasn't. Hover over the icon to see additional details.

  7. Select the Website, Store, and Source store view.

  8. Click Save.

    The connector is added to the list on the Connectors page.

Debug Mode

When reporting an issue to support please include the log file. The file contains all API calls.

  1. Go to Stores, click on Configuration, and select PHRASE.

  2. Under Configuration, set the Debug Mode to Yes.

    Save the configuration.

  3. Reproduce the issues

  4. Download /var/log/phrase_connector.log by clicking the Download link under the Debug Mode setting.

  5. Turn off the debug mode and optionally empty the log by clicking the Empty link.

Was this article helpful?

Sorry about that! In what way was it not helpful?

The article didn’t address my problem.
I couldn’t understand the article.
The feature doesn’t do what I need.
Other reason.

Note that feedback is provided anonymously so we aren't able to reply to questions.
If you'd like to ask a question, submit a request to our Support team.
Thank you for your feedback.