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

Create a DAO for the Gorgias Customers 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 MyCustomersDAO {
  //request specific data from Gorgias (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Customers WHERE Active = :active")
  String findNameByActive(@Bind("active") String active);

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

Open a Connection to Gorgias

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

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

Gorgias API Profile Settings

Use your Gorgias login email as the User and your API key as the Password. Your Domain is the subdomain from your Gorgias portal URL.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Gorgias.apip;ProfileSettings='User=your_email;Password=your_api_key;Domain=your_subdomain';

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\Gorgias.apip;ProfileSettings='User=your_email;Password=your_api_key;Domain=your_subdomain';");
MyCustomersDAO dao = dbi.open(MyCustomersDAO.class);

//do stuff with the DAO

dao.close();

Read Gorgias Data

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

//disply the result of our 'find' method
String name = dao.findNameByActive("true");
System.out.println(name);

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