Ready to get started?

Connect to live data from Zoom with the API Driver

Connect to Zoom

Create a Data Access Object for Zoom Data using JDBI

A brief overview of creating a SQL Object API for Zoom data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Zoom integrates connectivity to live Zoom data in Java applications. By pairing these technologies, you gain simple, programmatic access to Zoom data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read Zoom data.

Create a DAO for the Zoom MeetingRegistrants Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyMeetingRegistrantsDAO { //request specific data from Zoom (String type is used for simplicity) @SqlQuery("SELECT JobTitle FROM MeetingRegistrants WHERE State = :state") String findJobTitleByState(@Bind("state") String state); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Zoom

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Zoom.

Start by setting the Profile connection property to the location of the Zoom Profile on disk (e.g. C:\profiles\Zoom.apip). Next, set the ProfileSettings connection property to the connection string for Zoom (see below).

Zoom API Profile Settings

To authenticate to Zoom, you can use the OAuth standard to connect to your own data or to allow other users to connect to their data.

First you will need to create an OAuth app. To do so, navigate to and click Create under the OAuth section. Select whether or not the app will be for individual users or for the entire account, and uncheck the box to publish the app. Give the app a name and click Create. You will then be given your Client Secret and Client ID

After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to OAuth.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
  • OAuthClientID: Set this to the OAuth Client ID that is specified in your app settings.
  • OAuthClientSecret: Set this to the OAuth Client Secret that is specified in your app settings.
  • CallbackURL: Set this to the Redirect URI you specified in your app settings.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Zoom JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.api.jar

Fill in the connection properties and copy the connection string to the clipboard.

A connection string for Zoom will typically look like the following:


Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Zoom.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH"); MyMeetingRegistrantsDAO dao =; //do stuff with the DAO dao.close();

Read Zoom Data

With the connection open to Zoom, simply call the previously defined method to retrieve data from the MeetingRegistrants entity in Zoom.

//disply the result of our 'find' method String jobTitle = dao.findJobTitleByState("NC"); System.out.println(jobTitle);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Zoom by integrating with the CData JDBC Driver for Zoom. Download a free trial and work with live Zoom data in custom Java applications today.