Setup a REST Zoom Connection Manager

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

See Zoom REST Source Component for how to retrieve data from Zoom and Zoom REST Destination Component for how to write to Zoom.

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

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

SSIS REST Zoom Connection Manager

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 minute. Setting it to 0 would disable throttling.

Authentication
Authentication Mode

The Authentication Mode option allows you to choose the authentication mode when working with Zoom service. Available options are:

  • OAuth Mode
  • JWT
Generate Token File

This button allows you to login to the service endpoint and authorize your app to generate a token.

Zoom Connection Manager - OAuth

Here you can enter the Client ID and Client Secret which you would be getting from OAuth setup at the API side. The Redirect URL would be the one that you had specified in the App settings.

  • Use Default Browser to Sign In: When this option is checked the Sign In and Authorize button will open your default web browser 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 login to the service endpoint and authorize your app to generate a token.
Path To Token File

The path to the token file on the file system.

Token File Password

The password to the token file.

Client ID

The Client ID for the JWT Authentication (Available or JWT Mode).

Client Secret

The client secret for the JWT Authentication (Available for JWT Mode).

Test Connection

After all the connection information has been provided, click the "Test Connection" button to test if the user credentials entered can connect to the selected REST service.

Advanced Settings

Zoom Connection Manager - Advanced Settings

Proxy Server Settings
Proxy Mode

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

Miscellaneous Settings
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 Zoom 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.