Use JayDeBeApi to access ActiveCampaign Data in Python

Access ActiveCampaign data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for ActiveCampaign and the JayDeBeApi module to work with remote ActiveCampaign 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 ActiveCampaign and visualize ActiveCampaign 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 ActiveCampaign data in Python using SQL.

ActiveCampaign supports authenticating with the API Key. To connect to ActiveCampaign, set the following:

• URL: This can be found in your account on the My Settings page under the Developer tab. For example: https://{yourAccountName}.api-us1.com
• APIKey: This can be found in your account on the Settings page under the Developer tab. Each user in your ActiveCampaign account has their own unique API key.

Built-in Connection String Designer

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

java -jar cdata.jdbc.activecampaign.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:activecampaign:URL=yourUrl;APIKey=yourApiKey"

Access ActiveCampaign 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.activecampaign.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 ActiveCampaign:

import jaydebeapi

#The JDBC connection string
jdbc_url = "jdbc:activecampaign:URL=yourUrl;APIKey=yourApiKey"

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.activecampaign.jar"

conn = jaydebeapi.connect(
 "cdata.jdbc.activecampaign.ActiveCampaignDriver",
 jdbc_url,
 [username, password],
 jdbc_driver_jar,
)

cursor = conn.cursor()
cursor.execute("SELECT * FROM Contacts;")


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 JDBC Driver for ActiveCampaign and start working with your live ActiveCampaign data in Python. Reach out to our Support Team if you have any questions.