Ready to get started?

Connect to live data from Printify with the API Driver

Connect to Printify

Connect to Printify Data in Aqua Data Studio



Access Printify data from tools in Aqua Data Studio such as the Visual Query Builder and the Table Data Editor.

The CData JDBC Driver for Printify integrates Printify data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Printify data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Printify data source can then be accessed from Aqua Data Studio tools.

  1. In Aqua Data Studio, select Register Server from the Servers menu.
  2. In the Register Server form, select the 'Generic - JDBC' connection.
  3. Enter the following JDBC connection properties:
    • Name: Enter a name for the data source; for example, Printify.
    • Driver Location: Click the Browse button and select the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
    • Driver: Enter the Driver's class name, cdata.jdbc.api.APIDriver.
    • URL: Enter the JDBC URL, which starts with jdbc:api: and is followed by a semicolon-separated list of connection properties.

      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 typical JDBC URL is below:

      jdbc:api:Profile=C:\profiles\Printify.apip;ProfileSettings='APIKey=your_personal_token';

Query Printify Data

You can now query the tables exposed.