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

Create a DAO for the Ontraport Campaigns 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 MyCampaignsDAO {
  //request specific data from Ontraport (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Campaigns WHERE Deleted = :deleted")
  String findNameByDeleted(@Bind("deleted") String deleted);

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

Open a Connection to Ontraport

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

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

Ontraport API Profile Settings

In your Ontraport account, navigate to Administration > Integrations > ONTRAPORT API Instructions and Key Manager to obtain both your API Key and App ID.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Ontraport 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 Ontraport will typically look like the following:

jdbc:api:Profile=C:\profiles\Ontraport.apip;ProfileSettings='APIKey=your_api_key;AppId=your_app_id';

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

//do stuff with the DAO

dao.close();

Read Ontraport Data

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

//disply the result of our 'find' method
String name = dao.findNameByDeleted("false");
System.out.println(name);

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