Setting Up a Zuora 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 Zuora, among many more.
Integration for Zuora 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 the Zuora REST service:
- Service Name
-
The REST service that will be connected to.
- Instance Type (Since v25.2)
-
The instance Type of your Zuora’s endpoint can be chosen from the list.
-
- Base URL
-
The Base URL for REST Endpoints of the Zuora will reflect the instance type you have chosen. Refer to Zuora Documentation for more details.
- API Throttle Rate
-
The API Throttling Rate will limit the number of requests that can be sent per second.
- Organization IDs (Since v25.2)
- Use this to specify the organization (Ids) to which the account must belong to.
- Client Id
-
The Client Id option allows you to specify the unique ID which identifies the application making the request. Please refer to the “Create an OAuth Client for a User” section at Zuora Documentation.
- Client Secret
-
The Client Secret option allows you to specify the client secret belonging to your Zuora app.
- Get Entity Ids
-
If you have Zuora Multi-entity enabled, this button will retrieve all the IDs of the entities that you want to access to.
- Zuora Entity Ids
-
This dropdown menu allows you to choose the Entity ID you will be working with. Supply this field if your Zuora Multi-entity feature enabled.
- 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 a request 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 Zuora 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.