Connect to Paddle Data in Aqua Data Studio

The CData JDBC Driver for Paddle integrates Paddle data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Paddle 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 Paddle 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, Paddle.
   • 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.

     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.
     Set the following in the ProfileSettings connection property:
     • 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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     A typical JDBC URL is below:

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

   👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)
   

Query Paddle Data

You can now query the tables exposed.