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

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

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

Open a Connection to Workable

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

Using API Key Authentication

Workable uses API key authentication to control access to the API. To obtain an API Key:

1. Log in to your Workable account.
2. Navigate to Settings > Integrations > API Access Tokens.
3. Click "Generate API Token".
4. Copy the generated token.

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

• AuthScheme: Set this to APIKey.

• APIKey: Set this to your Workable API Key.
• Subdomain: Set this to your Workable account subdomain. For example, if your Workable URL is acmeinc.workable.com, then the Subdomain is 'acmeinc'.

Example Connection String

Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';

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\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';");
MyAccountsDAO dao = dbi.open(MyAccountsDAO.class);

//do stuff with the DAO

dao.close();

Read Workable Data

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

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