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

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

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

Open a Connection to Paddle

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

Using API Key Authentication

Paddle uses API key authentication. To obtain an API key:

1. Sign in to your Paddle account at https://vendors.paddle.com
2. Navigate to Developer Tools > Authentication
3. Click "Generate API Key"
4. Assign the appropriate permissions for the data you wish to access
5. Copy the generated key (sandbox keys begin with pdl_sdbx_apikey_; production keys begin with pdl_live_apikey_)

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

• AuthScheme: Set this to APIKey.

• APIKey: Set this to your Paddle API key.

Example Connection String

Profile=C:\profiles\Paddle.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

Connecting to Paddle

Once the authentication is configured, you can connect to Paddle and query data from any of the available tables such as Products, Customers, Subscriptions, and Transactions.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Paddle.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

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\Paddle.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";");
MyProductsDAO dao = dbi.open(MyProductsDAO.class);

//do stuff with the DAO

dao.close();

Read Paddle Data

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

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