Ready to get started?

Connect to live data from Printify with the API Driver

Connect to Printify

Integrate Printify Data in the Pentaho Report Designer



Publish reports based on Printify data in the Pentaho BI tool.

The CData JDBC Driver for Printify data enables access to live data from dashboards and reports. This article shows how to connect to Printify data as a JDBC data source and publish reports based on Printify data in Pentaho.

Connect and Create a Report

  1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
  2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.
  3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new Printify connection. In the resulting dialog, configure the connection properties as shown below.

    • Custom Connection URL property: Enter the JDBC URL. This 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.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

      Below is a typical JDBC URL:

      jdbc:api:Profile=C:\profiles\Printify.apip;ProfileSettings='APIKey=your_personal_token';
    • Custom Driver Class Name: Enter cdata.jdbc.api.APIDriver.
    • User Name: The username to authenticate with.
    • Password: The password to authenticate with.

Add Printify Data to a Report

You are now ready to create a report with Printify data.

  1. Add the Printify source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

  2. Configure the query. This article uses the one below:

    SELECT Id, ShippingMethod FROM Tags WHERE Status = 'pending'
  3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the Tags table.
  4. Finally, run the report to see the chart.