> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.syncspider.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# How to Integrate Magento 2 - Help Center - SyncSpider

**TABLE OF CONTENTS**

* [Description](#Description)
* [Entities](#Entities)
* [Setup](#Setup)
* [Step 1. Select Magento 2](#Step-1.-Select-Magento-2)
* [Step 2. Name the Integration](#Step-2.-Name-the-Integration)
* [Step 3. Download the Plugin](#Step-3.-Download-the-Plugin)
* [Step 4. Insert Credentials](#Step-4.-Insert-Credentials)
* [Method 1. Plain Authentication](#Method-1.-Plain-Authentication%C2%A0)
* [Method 2. Integration Authentication (2FA)](#Method-2.-Integration-Authentication-(2FA))

---
# Description

Magento is an ecommerce platform built on open source technology which provides online merchants with a flexible shopping cart system, as well as control over the look, content and functionality of their online store. Magento offers powerful marketing, search engine optimization, and catalog-management tools.

**Note:** Before integrating Magento 2 make sure that:

1. SSL Certificate is up to date and valid  
2. Two-Factor Authentication is enabled  
3. SyncSpider Magento 2 plugin is properly installed inside your Magento 2 backend

---
---
## Entities
| Source | Target |
| --- | --- |
| Category | Product Update |
| Customer | Product |
| Product | Order Update |
| Order | Order |
|  | Customer |
|  | Category |

Possible Task Triggers are: **_on schedule_** (hourly, daily, weekly, monthly) or **_upon successful completion of a trigger task._**

---
---
## Setup
## Step 1. Select Magento 2

Either while **Creating a Task** or in the Integrations menu.

Enter the name of the integration in the search bar.
![Selecting Magento 2 Integration](https://storage.crisp.chat/users/helpdesk/website/-/1/b/d/2/1bd2cd6c06035900/5e254f98-cfa8-44cd-804c-740dca_8mdb9a.png)

## Step 2. Name the Integration

Enter the Name of the Integration.

You can optionally also enter a description.
![Choosing a Name of the Integration](https://storage.crisp.chat/users/helpdesk/website/-/7/d/a/2/7da2806e63337400/ace12796-f624-4f78-a51c-ca29c2_emfgpn.png)

### 
## Step 3. Download the Plugin

![Inserting Website URL and Authentication Type](https://storage.crisp.chat/users/helpdesk/website/-/3/7/f/c/37fcc19c2f9a3c00/a97cae4a-82dc-4471-92f1-67c059_1ptl1vp.png)

Download the plugin by pressing the "Download plugin" button or by using the following link:  
[https://app.syncspider.com/storage/wrappers/magento2.zip](https://app.syncspider.com/storage/wrappers/magento2.zip)

1. Install the extension according to the steps mentioned in the page below:

[https://devdocs.magento.com/cloud/howtos/install-components.html](https://devdocs.magento.com/cloud/howtos/install-components.html)

1.2 Downloading and pasting method.

1.2.1 Press "Download" to download a module zip file.

1.2.2 Connect to your server via FTP or SSH.

1.2.3 Change your directory to your magento 2 root.

1.2.4 Create folder "SyncSpider" under `<magento2-root>/app/code`

1.2.5 Create folder "APIextension" under `<magento2-root>/app/code/SyncSpider`

1.2.6 extract the module zip file in the folder `<magento2-root>/app/code/SyncSpider/APIextension`

1.2.7 Connect to your server via SSH.

1.2.8 Execute the following commands:

1.2.8.1 change directory to your magento 2 root folder - `cd <magento2-root>`

1.2.8.2 enable maintenance mode - `php bin/magento maintenance:enable`

1.2.8.3 enable the module - `php bin/magento module:enable SyncSpider_APIextension`

1.2.8.4 upgrade database with module information - `php bin/magento setup:upgrade`

1.2.8.5 deploy static view file where <locale-list> is list with all the languages your store

uses, for example, de_DE en_US - `php bin/magento setup:static-content:deploy <locale-list>`

1.2.8.6 clean the cache - `php bin/magento cache:clean`

1.2.8.7 disable maintenance mode - `php bin/magento maintenance:disable`

1.3 Installing using a composer.

1.3.1 Select "Technical details" under the "Download" button.

1.3.2 Copy "Component name".

1.3.3 Connect to your server via SSH.

1.3.4 Execute the following commands:

1.3.4.1 change directory to your magento 2 root folder - `cd <magento2-root>`

1.3.4.2 enable maintenance mode - `php bin/magento maintenance:enable`

1.3.4.3 require the module package - `composer require "<Previously copied component name>" --no-dev`

1.3.4.4 enter credentials if necessary

1.3.4.5 enable the module - `php bin/magento module:enable SyncSpider_APIextension`

1.3.4.6 upgrade database with module information - `php bin/magento setup:upgrade`

1.3.4.7 deploy static view file where <locale-list> is list with all the languages your store

uses, for example, de_DE en_US - `php bin/magento setup:static-content:deploy <locale-list>`

1.3.4.8 clean the cache - `php bin/magento cache:clean`

1.3.4.9 disable maintenance mode - `php bin/magento maintenance:disable`

## Step 4. Insert Credentials
### Method 1. Plain Authentication

You will be prompted for the Website URL, Username and Password.
![Inserting Website URL, Username and Password](https://storage.crisp.chat/users/helpdesk/website/-/b/c/0/1/bc0184e3f88eb000/cbefca68-bf07-42fd-8c9a-2f6f3f_1cewxrp.png)

###

You will now be asked for the **Website URL**, Website URL in this case is Shop URL without any additions to it ( meaning without "/admin" )  and **the login credentials.**

Shop URL Example: [https://](https://www.yourdomain.com/magento/)myshop.com , it can be your IP adress or it can be custom, it depends on how you set it up.

![Inserting Website URL, Username and Password](https://storage.crisp.chat/users/helpdesk/website/-/8/a/8/0/8a809475bca73000/139d562b-d59d-44f7-871c-6daaa6_dp5p7s.png)

### Method 2. Integration Authentication (2FA)

This method has to be used in order to use Magento 2 with 2FA

log into your Magento 2 admin area.

![Logging into the Magento 2](https://storage.crisp.chat/users/helpdesk/website/-/1/9/b/3/19b3c404b9b43e00/c843d675-a0b1-4c04-99f1-38960b_1abvn9s.png)

* navigate to "System > Extensions > Integrations"

* Press the "Add New Integration" button

fill in the "Name" field which can be whatever identifier, for example, "SyncSpider"

* Under "API" tab set the "Resource Access" to "ALL" to prevent any issues

* press "Save"

* in the "Integrations" table press the "Activate" button next to the newly created integration

![Creating and Activating an Integration](https://storage.crisp.chat/users/helpdesk/website/-/3/c/3/a/3c3a3214afa92800/630b712d-1c11-4c8f-a6af-67fecf_j6a2eb.png)

* press "Allow" button in the opened modal to confirm the integration API access details

![Selecting the API Access scopes](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/3085097078/original/e80g-ycLSlBM-I52OtdCW6my962V_CqwkA.png?1660309011)

* open new tab and navigate to the Magento 2 integration configuration on app.syncspider.com

![Modifying the Integration Configuration](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/3085097075/original/Aifkl5-EvFjE0i2hou04GiDHAvHqO1lYMA.png?1660309010)

* choose the "integration" authentication type in the "Setup Magento 2 integration" module on [app.syncspider.com](https://app.syncspider.com/)

* Copy the authorized integration credentials from the previous Magento 2 tab into required fields on the "Setup Magento 2 integration" module on app.syncspider.com

![Inserting the Credentials](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/3085191787/original/dc-bWtXhX8EnitazNTTEgjUX8FjUIwLlJA.png?1660569414)

* press "Save" to save the integration credentials for the SyncSpider Magento 2 Integration on [app.syncspider.com](https://app.syncspider.com/).

![Inserting the Credentials](https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/3085191790/original/cPRh20AD506xNYoaggmtRaKGVic9qqANgw.png?1660569428)

---
---

**Magento 2** is just one of the tools we support!

To check the list of the tools and features we support please click [here](https://syncspider.com/integrations/)!

If you don't see your favorite tool on our list, please take the time and send us the request [here](https://roadmap.syncspider.com/boards/integrations?sort=cached_votes_up) to create an integration for you or UP-vote if it's already on the list :)

We develop integrations based on the requests and up-votes :)

We hope that this covers everything. If you have any further questions or need additional clarification please reach out to us via [[email protected]](/cdn-cgi/l/email-protection#c6b5b3b6b6a9b4b286b5bfa8a5b5b6afa2a3b4e8a5a9ab) or our chat widget!