Setting Up an Infusionsoft 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 Infusionsoft (Keap), among many more.
Integration for Infusionsoft is enabled by the following two components:
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 of configuration.
- General
- Advanced Settings
General Page
The General page allows you to specify connection properties and login credentials for Infusionsoft REST service:
- Service Name
-
The REST service that will be connected to.
- API Throttle Rate
-
The API Throttle Rate will limit the number of requests that can be sent per second.
- Infusionsoft Authentication
- Client ID
-
The Client ID of the PayPal app that will be used to connect to Infusionsoft. You must create a REST App for each Infusionsoft account that will use this component.
- Client Secret
-
The Client Secret of the Infusionsoft app that will be used to connect to Infusionsoft.
- Redirect Url
-
The Redirect Url option allows you to specify the Redirect Url to complete the authentication process.
- Sign in using the default web browser (Only available with OAuth Authorization Code authentication):
-
When this option is checked the Generate Token File button will open your default web browser in order to complete the OAuth authentication.
When this option is unchecked, the Generate Token File button will complete the entire OAuth authentication process inside of the toolkit.
- Generate Token File
-
This button allows you to log in to the service endpoint and authorize your app to generate a 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
- 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 Infusionsoft 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.
Custom Headers Page
The Custom Headers page will allow you to set the Header Name and Header Value. You may select the green icon to add another row, and the red icon to remove an existing header you have configured.