Setup a Shopify REST Connection Manager

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

See Shopify REST Source Component for how to retrieve data from Shopify & Shopify REST Destination Component for how to write to Shopify.

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 Shopify REST service:

SSIS REST Shopify Connection Manager

Service Name

The REST service that will be connected to.

Shop Name

The name of the Shopify instance to connect to.

API Throttle Rate

The API Throttle Rate will limit the number of requests that can be sent per second. Set this value to 0 to disable API Throttling

Authentication Mode

The Authentication Mode option allows you to specify how to authenticate with the Shopify server. Available options are:

  • Public App (OAuth)
  • Private App (API Key)
Sign in using default web browser

The Sign in using default web browser checkbox will provide you with the option to complete the entire OAuth authentication process within the toolkit (unchecked) or through your default web browser (checked). This option is used in conjunction with the Generate Token File... button.

Generate Token File...

The Generate Token File... button completes the OAuth authentication. After you click this button simply follow the steps in the dialog to generate your token.

Access Token

After successfully authorizing our app via the Generate Access Token (In App)... or Generate Access Token (In Browser)... buttons, your Access Token will be available here. Click the Show button to view it. This field is only available when the Authentication Mode is set to Public App (OAuth).

API Key

If you do not wish to use our app, you can create a private app in your Shopify admin. After you create the app you can enter the auto generated API Key here. This field is only available when the Authentication Mode is set to Private App (API Key).

Password

If you do not wish to use our app, you can create a private app in your Shopify admin. After you create the app you can enter the auto generated Password here. This field is only available when the Authentication Mode is set to Private App (API Key).

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

The Proxy Mode option allows you 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.

Port

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.

Timeout

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 Shopify 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.