Connect to Paddle Data in DBArtisan

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use wizards in DBArtisan to configure Paddle data as a data source.

The CData ODBC 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 an data source for Paddle in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.

Integrate Paddle Data into DBArtisan Projects

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

You can then 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 ODBC.
  3. Enter a name for the data source and select the DSN.
  4. 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.

Ready to get started?

Connect to live data from Paddle with the API Driver

Connect to Paddle