Learn more
 

Ready to get started?

Connect to live data from Klaviyo with the API Driver

Connect to Klaviyo

In this article

Related articles

Connect to Klaviyo Data in JRuby


Create a simple JRuby app with access to live Klaviyo data.

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for Klaviyo makes it easy to integrate connectivity to live Klaviyo data in JRuby. This article shows how to create a simple JRuby app that connects to Klaviyo data, executes a query, and displays the results.

Configure a JDBC Connection to Klaviyo Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Klaviyo\lib).

JRuby natively supports JDBC, so you can easily connect to Klaviyo and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

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

Klaviyo API Profile Settings

To authenticate to Klaviyo, you will needto provide an API Key. You can generate or view your API keys under 'My Account' > 'Setting' > 'API Key' > 'Create API Key'. Set the API Key to your Klaviyo Key in the ProfileSettings connection property.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Klaviyo 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 typical JDBC connection string for Klaviyo:

jdbc:api:Profile=C:\profiles\Klaviyo.apip;ProfileSettings='APIKey=my_api_key';

Create a JRuby App with Connectivity to Klaviyo Data

Create a new Ruby file (for example: APISelect.rb) and open it in a text editor. Copy the following code into your file:

require 'java' require 'rubygems' require 'C:/Program Files/CData/CData JDBC Driver for Klaviyo 2018/lib/cdata.jdbc.api.jar' url = "jdbc:api:Profile=C:\profiles\Klaviyo.apip;ProfileSettings='APIKey=my_api_key';" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Id, Name FROM Campaigns") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

With the file completed, you are ready to display your Klaviyo data with JRuby. To do so, simply run your file from the command line:

jruby -S APISelect.rb

Writing SQL-92 queries to Klaviyo allows you to quickly and easily incorporate Klaviyo data into your own JRuby applications. Download a free trial today!