Ready to get started?

Connect to live data from Printify with the API Driver

Connect to Printify

How to connect to Printify Data with Squirrel SQL client



Connect to Printify data and execute queries in the Squirrel SQL Client.

The CData JDBC Driver for Printify enables you to execute queries to Printify data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for Printify data and execute queries.

Add the JDBC Driver for Printify

Follow the steps below to add the driver JAR.

  1. In Squirrel SQL, click Windows -> View Drivers.
  2. Click the plus icon to open the Add Driver wizard.
  3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for Printify.
  4. In the Example URL box, enter jdbc:api:
  5. In the Extra Class Path tab, click Add.
  6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
  7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.api.APIDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

  1. Click Windows -> View Aliases.
  2. In the pane that lists the aliases, click the plus icon.
  3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

    • Name: Enter a name for the alias; for example, CData Printify Source.
    • Driver: Select the CData JDBC Driver for Printify.
    • URL: Enter jdbc:api:
  4. If you want to define any additional properties, click Properties.
  5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
  6. In the Specify column, select the checkboxes for the required 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.

    Below is a typical connection string:

    jdbc:api:Profile=C:\profiles\Printify.apip;ProfileSettings='APIKey=your_personal_token';
  7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query Printify Data

After the metadata has loaded, a new tab for the Printify data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT Id, ShippingMethod FROM Tags WHERE Status = 'pending'