Articles in this section

Set up a connection to Magento 2

Magento 2 is an eCommerce platform that helps businesses create and manage online stores, including products, customers, orders, inventory, payments, and shipping.

Set up a connection

Note

  • Errors while retrieving the token are often attributed to an incorrect base URI being used or your incorrect credentials. It's best to enter them in by hand and ensure that the browser autofill function doesn't override your activity.

  • For Magento accounts updated to 2.4.4 and above versions, the integration tokens can no longer be used for API bearer token authentication. To revert to the previous behavior, you should either disable two-factor authentication or run the bin/magento config:set oauth/consumer/enable_integration_as_bearer 1 command to restrict the new behavior. 

  • For Magento accounts using two-factor authentication, you have to enter the token in the Token field. 

  • For Magento accounts using two-factor authentication, when you upgrade to a higher version, integrator.io doesn't get the connection up and running. This is because Magento is expecting a new token for a successful connection with integrator.io. To resolve this, create a token outside of integrator.io, enter the token when logging into Magento, and then enter the same token in the Token field.

After you start the connection, configure it in the Create connection panel and complete all of the required * authentication settings:

Setting

Instructions

Name your connection * 

Enter a clear and distinguishable name.

Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.

Mode *

Choose your Magento 2 account mode:

  • Cloud: if you are connecting to a publicly accessible application

  • On-premise: if you are connecting to an application behind your firewall, such as a database or custom HTTP endpoint. On-premises connections require installing an agent within your network.

Agent *

If On-premise selected for Mode; otherwise not displayed): Select an agent from the list. To connect to an on-premise application, integrator.io requires that an agent be installed on a networked computer. An agent is a small application that allows you to connect to data behind your firewall. When installing an agent, you will specify a unique access token, which then populates the Agent drop-down list. The installed agents connect to integrator.io and establish a reverse SSH tunnel, allowing secure communication without the need to whitelist integrator.io IP addresses in your firewall settings. Multiple different connections can use a single agent.

Base URI *

Enter your Magento 2 account base URI. For example, if your account URL is http://123.12.12.1/xyz/admin, then replace admin with rest and enter the base URI as http://123.12.12.1/xyz/rest.

Auth type *

Select your Magento 2 authentication type (CustomToken, or OAuth 1.0).

Token authentication

Username *

Enter your Magento 2 account username (admin). For more information on retrieving the username, see Token authentication.

Password *

Enter your Magento 2 account password (admin). For more information on retrieving the password, see Token authentication.

Custom authentication

Access token *

Enter your Magento 2 access token. For more information on retrieving the access token, see Token authentication.

OAuth 1.0 authentication

Consumer key *

Enter your Magento 2 consumer key. For more information on retrieving the consumer key, see OAuth authentication.

Consumer secret *

Enter your Magento 2 consumer secret. For more information on retrieving the consumer secret, see OAuth authentication.

Multiple layers of protection, including AES 256 encryption, are in place to keep your secret safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

Access token *

Enter your Magento 2 access token. For more information on retrieving the access token, see OAuth authentication.

Multiple layers of protection, including AES 256 encryption, are in place to keep your token safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

Token secret *

Enter your Magento 2 token secret. For more information on retrieving the token secret, see OAuth authentication.

Multiple layers of protection, including AES 256 encryption, are in place to keep your secret safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

Tip

This connector documentation describes only the settings shown for the Simple view. For the corresponding HTTP settings, see the Token auth universal connector documentation.