Help Manual - GetResponse Connection Manager

Setting Up a GetResponse REST Connection Manager

The REST Connection Manager is an SSIS connection manager that can be used to establish connections and facilitate data integration with REST-based APIs and services, such as GetResponse, among many others.

Integration for GetResponse is enabled by two components: the source component, which retrieves data from GetResponse, and the destination  component, which writes to your GetResponse environment:

• GetResponse REST Source Component
• GetResponse REST Destination Component
  

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.

The REST Connection Manager contains 2 pages for configuration:

• General
• Advanced Settings

General Page

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

Service Name

The REST service that will be connected to.

General Settings

API Throttle Rate

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

Base URL

Depending on the instance type, you may select the Base URL from the dropdown.

Custom Domain

You have the option to specify a custom domain for your site.

Authentication

There are four types of authentication modes that you could use:

1. OAuth Authorization Code
2. OAuth Implicit
3. Client Credentials
4. API Key

1. OAuth Authorization Code

Generate Token File...

This button opens a dialogue box in order to sign in to your instance to generate a new Token.

App Info

• The Client ID and Client Secret are to be used when authenticating the GetResponse service.
• Redirect URL: The Redirect Url option allows you to specify the Redirect Url to complete the authentication process.

Sign In & Authorize

• Use Default Browser to Sign In: When this option is checked the Sign In and Authorize button will open your default web browser in order to complete the OAuth authentication. When this option is unchecked, the Sign In and Authorize button will complete the entire OAuth authentication process inside of the toolkit.
• Sign In and Authorize: This button allows you to log in to the service endpoint and authorize your app to generate a token.

Path To Token File

This option allows you to enter the path to the token file on the file system.

Token File Password

The password to the token file.

2. Implicit

The Implicit authentication option is an OAuth 2.0 flow used to grant access to a token when sensitive data is not able to be stored on a secure server.

Generate Token...

This button opens a dialogue box in order to sign in to your instance to generate a new Token

App Info

• Client ID: Used for authenticating the GetResponse service.
• Redirect URL: The Redirect Url option allows you to specify the Redirect Url to complete the authentication process.

Sign In & Authorize

• Use Default Browser to Sign In: When this option is checked the Sign In and Authorize button will open your default web browser in order to complete the OAuth authentication. When this option is unchecked, the Sign In and Authorize button will complete the entire OAuth authentication process inside of the toolkit.
• Sign In and Authorize: This button allows you to log in to the service endpoint and authorize your app to generate a token.

Access Token

The Access Token will be populated when you generate the token.

3. Client Credentials

The Client ID and Client Secret are to be used when authenticating the GetResponse service.

4. API Key

The API Key option allows you to enter your own API token which is going to be used to connect to your instance.

Advanced Settings Page

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 the 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)

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

Password (Proxy Server Authentication)

The 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 GetResponse servers.

Warning: Enabling the "Ignore Certificate Errors" option is generally NOT recommended, particularly for production instances. 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.