Ready to get started?

Connect to live data from Shippo with the API Driver

Connect to Shippo

Create a Data Access Object for Shippo Data using JDBI

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

Create a DAO for the Shippo Orders 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 MyOrdersDAO { //request specific data from Shippo (String type is used for simplicity) @SqlQuery("SELECT OrderStatus FROM Orders WHERE ShopApp = :shopApp") String findOrderStatusByShopApp(@Bind("shopApp") String shopApp); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Shippo

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

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

Shippo API Profile Settings

In order to authenticate to Shippo, you will need an API Key. You can find this API key under 'Settings' > 'API' > 'Generate Token'. After generating your key, set it to the APIKey in ProfileSettings connection property.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Shippo 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 Shippo 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\Shippo.apip;ProfileSettings='APIKey=my_api_key';"); MyOrdersDAO dao =; //do stuff with the DAO dao.close();

Read Shippo Data

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

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

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