Rapidly Develop Paddle-Driven Apps with Active Query Builder
Write standard .NET to expose Paddle data through an SQL interface: Active Query Builder helps developers write SQL interfaces; the CData ODBC Driver for Paddle enables standards-based access to Paddle. This integration uses the Microsoft ADO.NET Provider for ODBC as a bridge between the ODBC Driver and the Active Query Builder objects to build a visual SQL composer.
Connect to Paddle as an ODBC Data Source
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:
- Sign in to your Paddle account at https://vendors.paddle.com
- Navigate to Developer Tools > Authentication
- Click "Generate API Key"
- Assign the appropriate permissions for the data you wish to access
- 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.
- 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.
Use SQL to Interact with Paddle
Follow the steps below to create a WinForms visual query builder.
- Open Active Query Builder for .NET WinForms.
- In the new Windows Forms project go to the "File" menu and click "Connect..."
- Under Database Connections, click "Add..."
- Set your desired Connection Name (e.g. CData Paddle), set Connection Type to "ODBC" and locate your previously configured DSN in the "User/System" DSN dropdown.
- Click "OK" to save the new connection.
- Back in the Database Connection wizard, select the newly created connection and click "OK."
- Click "File" > "New Query" to create a QueryBuilder
You can now build queries visually: Double-click a table in the Columns Pane Area and an entity/relationship diagram is displayed in the Query Building Area. Columns that you select in the diagram are added to the query.