Connect to Keap Data in JRuby

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

Configure a JDBC Connection to Keap 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 Keap\lib).

JRuby natively supports JDBC, so you can easily connect to Keap 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 Keap Profile on disk (e.g. C:\profiles\Keap.apip). Next, set the ProfileSettings connection property to the connection string for Keap (see below).

Keap API Profile Settings

Log into your Keap web app, click the user bubble in the bottom left, choose Settings > API, then generate a new Personal Access Token or Service Account Key.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Keap.apip;ProfileSettings='APIKey=your_api_key';

Create a JRuby App with Connectivity to Keap 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 Keap 2018/lib/cdata.jdbc.api.jar'

url = "jdbc:api:Profile=C:\profiles\Keap.apip;ProfileSettings='APIKey=your_api_key';"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT Name, Email FROM Account")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S APISelect.rb

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