Setup a REST PayPal Connection Manager

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

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

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

General page

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

SSIS REST PayPal Connection Manager

Service Name

The REST service that will be connected to. 

Environment

The Environment that the component will connect to, either Production or Sandbox.  The Base URL setting will be automatically set to appropriate default value when the environment is set, but this value can be changed.

Base URL

The Base URL that will be used to send PayPal api requests.

API Throttle Rate

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

PayPal Authentication
Client ID

The Client ID of the PayPal app that will be used to connect to PayPal.  You must create a Rest App for each PayPal account that will use this component.  This can be done in the Account section of the PayPal website when logged in.  API Access is only available for Business accounts, but not for Personal accounts.

Client Secret

The Client Secret of the PayPal app that will be used to connect to PayPal.

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 page

REST Connection Manager - Advanced

Proxy Mode

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.