Ready to get started?

Connect to live data from BambooHR with the API Driver

Connect to BambooHR

Create a Data Access Object for BambooHR Data using JDBI

A brief overview of creating a SQL Object API for BambooHR 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 BambooHR integrates connectivity to live BambooHR data in Java applications. By pairing these technologies, you gain simple, programmatic access to BambooHR data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read BambooHR data.

Create a DAO for the BambooHR Employees 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 MyEmployeesDAO { //request specific data from BambooHR (String type is used for simplicity) @SqlQuery("SELECT DisplayName FROM Employees WHERE Department = :department") String findDisplayNameByDepartment(@Bind("department") String department); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to BambooHR

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

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

BambooHR API Profile Settings

In order to authenticate to BambooHR, you'll need to provide your API Key. To generate an API key, log in and click your name in the upper right-hand corner of any page to get to the user context menu. If you have sufficient permissions, there will be an "API Keys" option in that menu to go to the page, where you can create a new API Key. Additionally, you will need to set the Domain, found in the domain name of your BambooHR account. For example if your BambooHR account is, then the Domain should be 'acmeinc'. Set both the API Key and Domain in the ProfileSettings property to connect.

Built-in Connection String Designer

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


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\BambooHR.apip;ProfileSettings='Domain=acmeinc;APIKey=your_api_key';"); MyEmployeesDAO dao =; //do stuff with the DAO dao.close();

Read BambooHR Data

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

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

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