Learn more
 

Ready to get started?

Connect to live data from Zoom with the API Driver

Connect to Zoom

In this article

Related articles

Use JayDeBeApi to access Zoom Data in Python


Use standard Python scripting and the development environment of your choice to access live Zoom data.

Access Zoom data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData API Driver for JDBC and the JayDeBeApi module to work with remote Zoom data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to Zoom and visualize Zoom data with standard Python.

Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with Zoom data in Python using SQL.

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 https://marketplace.zoom.us/develop/create 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.

Below is a sample variable assignment, including a typical JDBC connection string:

jdbc_url = "jdbc:api:Profile=C:\profiles\Zoom.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH"

Access Zoom data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.api.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from Zoom:

import jaydebeapi #The JDBC connection string jdbc_url = "jdbc:api:Profile=C:\profiles\Zoom.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH" username = "****" password = "****" #The absolute Path to the JDBC driver JAR file, typically: jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.api.jar" conn = jaydebeapi.connect( "cdata.jdbc.api.jar", jdbc_url, [username, password], jdbc_driver_jar, ) cursor = conn.cursor() cursor.execute("SELECT * FROM MeetingRegistrants;") results = cursor.fetchall() for row in results: print(row) cursor.close() conn.close()

Free trial & more information

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live Zoom data in Python. Reach out to our Support Team if you have any questions.