Create a Data Access Object for ZeroBounce Data using JDBI

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
A brief overview of creating a SQL Object API for ZeroBounce data in 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 ZeroBounce integrates connectivity to live ZeroBounce data in Java applications. By pairing these technologies, you gain simple, programmatic access to ZeroBounce data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read ZeroBounce data.

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

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

Open a Connection to ZeroBounce

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

Using API Key Authentication

ZeroBounce uses API key authentication. To obtain an API key:

  1. Log in to your ZeroBounce account at https://app.zerobounce.net
  2. Navigate to the API tab in your account dashboard
  3. Copy the API key displayed on the page

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

  • AuthScheme: Set this to APIKey.
Set the following in the ProfileSettings connection property:
  • APIKey: Set this to your ZeroBounce API key.

Example Connection String

Profile=C:\profiles\ZeroBounce.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 ZeroBounce 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 ZeroBounce will typically look like the following:

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

//do stuff with the DAO

dao.close();

Read ZeroBounce Data

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

//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 ZeroBounce by integrating with the CData JDBC Driver for ZeroBounce. Download a free trial and work with live ZeroBounce data in custom Java applications today.

Ready to get started?

Connect to live data from ZeroBounce with the API Driver

Connect to ZeroBounce