Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Create a Data Access Object for Printify Data using JDBI
A brief overview of creating a SQL Object API for Printify 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 Printify integrates connectivity to live Printify data in Java applications. By pairing these technologies, you gain simple, programmatic access to Printify data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read Printify data.
Create a DAO for the Printify Tags 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 MyTagsDAO {
//request specific data from Printify (String type is used for simplicity)
@SqlQuery("SELECT ShippingMethod FROM Tags WHERE Status = :status")
String findShippingMethodByStatus(@Bind("status") String status);
/*
* close with no args is used to close the connection
*/
void close();
}
Open a Connection to Printify
Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Printify.
Start by setting the Profile connection property to the location of the Printify Profile on disk (e.g. C:\profiles\Profile.apip). Next, set the ProfileSettings connection property to the connection string for Printify (see below).
Printify API Profile Settings
In order to authenticate to Printify, you'll need to provide your API Key. To get your API Key navigate to My Profile, then Connections. In the Connections section you will be able to generate your Personal Access Token (API Key) and set your Token Access Scopes. Personal Access Tokens are valid for one year. An expired Personal Access Token can be re-generated using the same steps after it expires. Set the API Key to your Personal Access Token in the ProfileSettings property to connect.
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the Printify 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 Printify will typically look like the following:
jdbc:api:Profile=C:\profiles\Printify.apip;ProfileSettings='APIKey=your_personal_token';
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\Printify.apip;ProfileSettings='APIKey=your_personal_token';");
MyTagsDAO dao = dbi.open(MyTagsDAO.class);
//do stuff with the DAO
dao.close();
Read Printify Data
With the connection open to Printify, simply call the previously defined method to retrieve data from the Tags entity in Printify.
//disply the result of our 'find' method
String shippingMethod = dao.findShippingMethodByStatus("pending");
System.out.println(shippingMethod);
Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Printify by integrating with the CData JDBC Driver for Printify. Download a free trial and work with live Printify data in custom Java applications today.