Manage Paddle Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Paddle seamlessly integrates Paddle data into database management tools like DBArtisan by enabling you to access Paddle data as a database. This article shows how to create a JDBC source for Paddle in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Paddle Data into DBArtisan Projects

Follow the steps below to register Paddle data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

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

6. Finish the wizard to connect to Paddle data. Paddle entities are displayed in the Datasource Explorer.

You can now work with Paddle data as you work with any other database. See the driver help documentation for more information on the queries supported by the Paddle API.