Query Paddle Data as a MySQL Database in Node.js

You can use the SQL Gateway from the ODBC Driver for Paddle to query Paddle data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and start querying using Node.js.

Connect to Paddle Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

• 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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Paddle data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query Paddle from Node.js

The following example shows how to define a connection and execute queries to Paddle with the mysql module. You will need the following information:

• Host name or address, and port: The machine and port where the MySQL remoting service is listening for MySQL connections.
• Username and password: The username and password of a user you authorized on the Users tab of the SQL Gateway.
• Database name: The DSN you configured for the MySQL remoting service.

Connect to Paddle data and start executing queries with the code below:

var mysql      = require('mysql');
var connection = mysql.createConnection({
  host     : 'localhost',
  database : 'CData API Sys',
  port	   : '3306',
  user     : 'mysql_user',
  password : 'test'
});
connection.connect();
connection.query('SELECT * FROM Products', function(err, rows, fields) {
  if (err) throw err;
  console.log(rows);
});

connection.end();