Setup a REST Magento Connection Manager

The REST Connection Manager is an SSIS connection manager component that can be used to establish connections with Magento REST service to help facilitate data integration for Magento.

See Magento REST Source Component for how to retrieve data from Magento and Magento REST Destination Component for how to write to Magento.

To add a new connection, right-click the Connection Manager area in your Visual Studio project, and choose "New Connection..." from the context menu. You will be prompted the "Add SSIS Connection Manager" window. Select the "REST (KingswaySoft)" item to add a new REST Connection Manager.

New SSIS Connection

Add SSIS REST Connection Manager

The REST Connection Manager contains 2 pages of configuration.

  • General
  • Advanced Settings

General page

The General page allows you to specify connection properties and login credentials for Magento REST service:

SSIS REST Magento Connection Manager

Service Name

The REST service that will be connected to.

Service URL

The full URL of the Magento instance that will be connected to.

Store Code

This option allows you to specify the store code which is going to be connected to.

API Throttle Rate

The API Throttling Rate will limit the number of requests that can be sent per minute.

Authentication Token 

If you have an authentication token that you would like to use, enter it in the authentication field, and check the 'Admin Token' checkbox if it is an Admin token. If it is a customer token do not check the box. If you do not have a Magento token you can generate one by clicking the Generate Token button.

Generate Token Button 

If you click the Generate Token button the 'Generate Token' dialog will appear. You can enter credentials for a Magento user, and then generate an admin token, or a customer token depending on what kind of user you use to access Magento. The generated token will automatically populate the 'Authentication Token' field and check the 'Admin Token' checkbox as appropriate. Credentials entered in this dialog are not saved, they are just used to generate a token and then discarded. 

Show Token Button 

If you need to see or copy the token in the 'Authentication Token' field click the 'Show Token' button to reveal the text of the token. 

Test Connection

After all the connection information has been provided, you may click the "Test Connection" button to test if the user credentials entered can connect to the selected REST service.

Advanced Settings page

REST Connection Manager - Advanced

Proxy Mode

Proxy Mode option allows to specify how you want to configure the proxy server setting. There are three options available.

  • No Proxy
  • Auto-detect (Using system configured proxy)
  • Manual
Proxy Server

Using Proxy Server option allows you to specify the name of the proxy server for the connection.


The Port option allows you to specify the port number of the proxy server for the connection.

Username (Proxy Server Authentication)

Username option (under Proxy Server Authentication) allows you to specify the proxy user account.

Password (Proxy Server Authentication)

Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.

Note: The Proxy Password is not included in the connection manager's ConnectionString property by default. This is by design for security reasons. However, you can include it in your ConnectionString if you want to parameterize your connection manager. The format would be ProxyPassword=myProxyPassword; (make sure you have a semicolon as the last character). It can be anywhere in the ConnectionString.


The number of seconds requests should wait before timing out.

Retry on Intermittent Errors

The retry on intermittent errors option determines if requests will be retried when there is an error. If this option is checked requests will be retried up to 3 times.

Ignore Certificate Errors

This option can be used to ignore those SSL certificate errors when connecting to Slack servers.

Warning: Enabling "Ignore Certificate Errors" option is generally NOT recommended, particularly for production instance. Unless there is a strong reason to believe the connection is secure - such as the network communication is only happening in an internal infrastructure, this option should be unchecked for best security.