1. Help Center
  2. Integrate your Store
  3. Integration by module or app
  4. Magento

Guide to Integrating with Magento 2

Avatar
Connectif Support
Created
Updated
Follow

If your eCommerce is developed in Magento, you can easily integrate it with Connectif and start collecting data from your customers to create your campaigns.

In this article, you will learn how to install and configure the Connectif module for Magento 2.

 
Implementation time: 15-20 min.
Difficulty: Advanced (requires technical knowledge).
When to use it?: When opening your account in Connectif.

 

STEP 1. Download and installation of the Magento 2 module

Depending on the version of Magento your eCommerce uses, you must follow different steps:

  • If you have a version earlier than Magento 2.2, review section A of this step.
  • If you have a version later than Magento 2.2, review section B of this step.

 

A. Versions earlier than Magento 2.2

A.1. Download the module

1. Access your Connectif account.

2. Go to Integrations in the left-side menu.

3. In the ERPs and CRMs section, find Magento and click  Edit.

Magento_Integracion_-_1.png

4. In the Configuration section, click  Download Magento 2 Module to download the file “connectif.zip” to your computer.

Magento_Integracion_-_2.png

 

A.2. Copy the Connectif folder to the Magento installation

5. Copy the "Connectif" folder and all its content into the "/app/code/" folder, located in the root of the Magento 2 installation.

 

If the "/app/code/" folder does not exist, it must be created.

 

For example, if the Magento 2 installation path is "/var/www/html", you should copy the "Connectif" folder to "/var/www/html/app/code/Connectif".

 

A.3. Install the module

6. Access the Magento 2 admin panel and go to "System > Web Setup Wizard".

 

The Setup Wizard is removed starting from Magento 2.4.0, so you will need to enable the integration via commands, which can be found in section 2b of the installation documentation included in the "connectif.zip" file downloaded in step 2. Find more information in the Magento documentation.

Magento_Integracion_-_3.png

7. In Module Manager, find the Connectif_Integration module and select Activate.

Magento_Integracion_-_4.png

8. Follow the steps prompted during the installation of the Connectif module and click Next:

  • Readiness Check: this step checks for PHP version, crons, dependencies, and extensions.

Magento_Integracion_-_5.png

  • Backup: this step creates a backup of the eCommerce before the module installation.

Magento_Integracion_-_7.png

  • Enable module: this step activates the module.

Magento_Integracion_-_8.png

 

B. Versions later than Magento 2.2

B.1. Download the module

9. Access your Connectif account.

10. Go to Integrations in the left-side menu.

11. In the ERPs and CRMs section, find Magento and click  Edit.

Magento_Integration_-_1.png

12. In the Configuration section, click  Download Magento 2 Module to download the file “connectif.zip” to your computer.

Magento_Integration_-_2.png

B.2. Copy the Connectif folder to the Magento installation

13. Log into your Magento 2.x store via an SSH connection.

14. After a successful SSH login, use the command line (shell) to navigate to the root directory of Magento where Magento 2 is installed.

15. Upload the module (as a Zip or tar.gz) to the root directory of the Magento 2 installation.

16. Extract the file into a temporary directory.

17. The location to copy the extracted module should be “app/code/Connectif/”. Create this folder with the following command:

mkdir –p app/code/Connectif/

18. Copy the content of the extracted folder into the newly created folder:

cp -R Connectif/* app/code/Connectif/

19. Run the Magento 2 installation command from the root:

php bin/magento setup:upgrade

20. Compile the installed module with:

php bin/magento setup:di:compile

21. Clear the cache with:

php bin/magento cache:flush
 

The module will be installed and visible in Stores > Configuration > Advanced > Advanced. The module will appear in this section in the list of installed Magento modules.

 

STEP 2. Activate the module

 

This configuration is the same for versions earlier and later than Magento 2.2.

22. Go to "Stores > Configuration > " and locate the Connectif configuration.

Magento_Integration_-_9.png

23. In the Basic Configuration section, select the option Yes in the Activate field to enable the Client ID and Secret Key fields.

 

Do not close this tab; you will need it to complete your account details.

Magento_Integration_-_13_2.png

24. Access your Connectif account and, in the "Integrations > Magento" section, copy the Client ID and the Secret Key.

Magento_Integration_-_11.png

25. Return to Magento 2 and paste them into the corresponding fields.

Magento_Integration_-_12.png

26. Click "Save Config" to save the changes.

 

 

Success!
Your integration of Connectif with Magento is ready.

 

Once the plugin configuration is complete, it is recommended to verify the integration. You can see how to do this in this article.

 

Frequently Asked Questions

Do you have questions about the Connectif module in Magento? Here you will find useful information:

1. What is each section of the Connectif module in Magento for?

The Connectif module in Magento has several sections, each serving different purposes:

  • Basic Configuration (1): this section configures the basic aspects of your Connectif account in Magento, documented in this article, allowing you to start your strategy.

Magento_Integracion_-_14.png

  • Banners (2): this section is deprecated, as banner format content is configured directly from Connectif.
  

"Modal Windows" and "Banners" content types have been deprecated since 2021. This article explains how to migrate them to Connectif.

Magento_Integracion_-_15.png

  • Public URLs (3): this section is used to check the activation URLs for ServiceWorker and subscription notifications.

These URLs are generated and communicated to Connectif when the module is installed in Magento.

Magento_Integracion_-_16.png

  • Advanced Configuration (4): this section establishes certain behaviors in the integration with Connectif:
    • Print only mandatory fields on cart tags?: this option specifies if the Connectif script will only collect mandatory cart fields (Product ID, name, price, and URL). This option can improve cart tag performance in Magento.
    • Use product variants on cart and purchases?: this option determines whether Connectif collects the default product or the specific variant when receiving cart product information.
    • Product image ID: this option specifies the image size that Connectif will collect.
    • Notify purchases offline: this option determines if the eCommerce will notify Connectif of offline purchases via API without a web context.
    • Order Status: this option specifies the status that purchases need to be in to be registered via API (offline notifications) in Connectif.

Magento_Integracion_-_17.png

 

2. How to activate offline purchase notifications (via API)?

  

Offline purchase notifications mean that they do not have a web context, as the notification is made via API asynchronously. If there is a strategy that reacts to purchases with web content, it will not impact contacts whose purchase is recorded through the API.

1. In your Magento account, go to "Stores > Configuration", click on Connectif and Settings.

Magento_Integracion_-_18.png

2. Disable the Connectif module from "Basic Configuration > Activate", selecting the No option.

Magento_Integracion_-_19.png

3. Click on Save Config.

 

Configuration must be saved immediately after this step to enable offline purchases.

4. Go to "Advanced Configuration > Notify purchases offline", and select the Yes option.

Magento_Integracion_-_20.png

5. In "Order Status", choose the status that purchases must be in to be registered offline in Connectif.

  

The selected status will depend on the payment method, Magento configuration, and business model. Only one status can be selected.

Magento_Integracion_-_21.png

6. Re-enable the Connectif module from "Basic Configuration > Activate", selecting the Yes option.

Magento_Integracion_-_22.png

7. Click Save Config.

 

3. How to configure Connectif in a multi-language Magento store?

Magento allows for three levels of entities within an account:

  • Website: typically only one, corresponding to the domain.
  • Store: the different stores, for example, by language.
  • Store view: other details for stores, such as the same language but with a different currency.

The Connectif module can be configured at any of these levels according to eCommerce needs, but some aspects must be considered:

  • Magento configuration types, as configuration in "Default" mode applies to all Magento levels.
  • To send data from different Magento levels to the same Connectif store, the same Client ID and Secret Key must be used in the configuration.
  • It is recommended, except in very complex cases, to activate the default configuration at the time of integration, to configure all levels equally.

If you have multiple languages and/or currencies to configure, it is common to make adjustments at the Store View level separately.

Group 2-min.png

 

4. How to recover abandoned carts with the Cart Recovery URL

(This section explains how the Cart Recovery URL works to retrieve items associated with a specific cart).

Through integration with Magento, Connectif provides a Cart Recovery URL, a link that can be used to recover cart-related items and used in workflows and content.

To obtain the cart recovery URL through a workflow, use the "Get Last Cart" and "On Cart Abandonment" nodes, then map it to the content variables to be displayed or sent.

  • Learn how this URL works in different CMS and how to use it in this article. 

 

 

 

Keep learning!

To take full advantage of your Connectif account, we recommend continuing with the following articles:

Was this article helpful?
1 out of 1 found this helpful