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

Create a DAO for the Aircall Calls 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 MyCallsDAO {
  //request specific data from Aircall (String type is used for simplicity)
  @SqlQuery("SELECT Direction FROM Calls WHERE Status = :status")
  String findDirectionByStatus(@Bind("status") String status);

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

Open a Connection to Aircall

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

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

Aircall API Profile Settings

In Aircall, go to your company settings and create a new API key to receive an API ID and API token. Combine them as

APIId:APIToken

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Aircall.apip;ProfileSettings='APIKey=your_api_id:your_api_token';

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\Aircall.apip;ProfileSettings='APIKey=your_api_id:your_api_token';");
MyCallsDAO dao = dbi.open(MyCallsDAO.class);

//do stuff with the DAO

dao.close();

Read Aircall Data

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

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

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