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

Create a DAO for the Yotpo ProductBottomLine 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 MyProductBottomLineDAO {
  //request specific data from Yotpo (String type is used for simplicity)
  @SqlQuery("SELECT AverageScore FROM ProductBottomLine WHERE ExternalProductId = :externalProductId")
  String findAverageScoreByExternalProductId(@Bind("externalProductId") String externalProductId);

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

Open a Connection to Yotpo

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

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

Yotpo API Profile Settings

To authenticate to Yotpo, you can use the OAuth 2.0 client credentials flow with your Yotpo AppKey and AppSecret.

To use the Yotpo API, you need a Yotpo store account with an AppKey and AppSecret. You can find these credentials in the Yotpo dashboard under Account Settings > Store.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to OAuthClient.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
• OAuthClientId: Set this to your Yotpo AppKey.
• OAuthClientSecret: Set this to your Yotpo AppSecret.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;

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\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;");
MyProductBottomLineDAO dao = dbi.open(MyProductBottomLineDAO.class);

//do stuff with the DAO

dao.close();

Read Yotpo Data

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

//disply the result of our 'find' method
String averageScore = dao.findAverageScoreByExternalProductId("my-product-sku");
System.out.println(averageScore);

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