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

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

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

Open a Connection to Deel

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

To authenticate to Deel, you can use API Key (Bearer Token) authentication.

Using APIKey Authentication

You can authenticate using a Deel API Key. Create an API key in your Deel account settings under Settings > API or Developer Settings. Make sure to grant appropriate permissions based on the data you need to access (e.g., read access for invoices, timesheets, contracts, workers, etc.).

After creating your API Key, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Deel API Key (Bearer token).

Example APIKey connection string

Profile=C:\profiles\Deel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_deel_api_key';

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Deel Data

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

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