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

Create a DAO for the Reply.io BillingInfo 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 MyBillingInfoDAO {
  //request specific data from Reply.io (String type is used for simplicity)
  @SqlQuery("SELECT  FROM BillingInfo WHERE  = :")
  String findBy(@Bind("") String );

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

Open a Connection to Reply.io

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

The Reply.io API uses API Key authentication via the x-api-key request header.

Using API Key Authentication

Your Reply.io API key is required to create a connection. To obtain your API key:

1. Log into your Reply.io account.
2. Click your profile icon and select Settings.
3. Navigate to the API section.
4. Copy your API Key.

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Reply.io API key.
• UserEmail (optional): Set this to the email address of the Reply.io user on whose behalf requests are made.

Example connection string:

Profile=C:\profiles\ReplyIO.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\ReplyIO.apip;AuthScheme=APIKey;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\ReplyIO.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';");
MyBillingInfoDAO dao = dbi.open(MyBillingInfoDAO.class);

//do stuff with the DAO

dao.close();

Read Reply.io Data

With the connection open to Reply.io, simply call the previously defined method to retrieve data from the BillingInfo entity in Reply.io.

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

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