Create a Data Access Object for Keap Data using 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 Keap integrates connectivity to live Keap data in Java applications. By pairing these technologies, you gain simple, programmatic access to Keap data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read Keap data.

Create a DAO for the Keap Account 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 MyAccountDAO {
  //request specific data from Keap (String type is used for simplicity)
  @SqlQuery("SELECT Email FROM Account WHERE Email = :email")
  String findEmailByEmail(@Bind("email") String email);

  /*
   * close with no args is used to close the connection
   */
  void close();
}

Open a Connection to Keap

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

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.

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

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

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\Keap.apip;ProfileSettings='APIKey=your_api_key';");
MyAccountDAO dao = dbi.open(MyAccountDAO.class);

//do stuff with the DAO

dao.close();

Read Keap Data

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

//disply the result of our 'find' method
String email = dao.findEmailByEmail("[email protected]");
System.out.println(email);

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