Query Gumroad Data through ODBC in Node.js

Node.js is a JavaScript runtime environment that allows you to run JavaScript code outside of a browser. With the CData API Driver for ODBC, you can access live Gumroad data from Node.js apps and scripts. In this article, we walk through installing node-odbc and the required tools to create a simple Node.js app with access to live Gumroad data.

With built-in optimized data processing, the CData ODBC Driver offers unmatched performance for interacting with live Gumroad data in Node.js. When you issue complex SQL queries from Node.js to Gumroad, the driver pushes supported SQL operations, like filters and aggregations, directly to Gumroad and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Gumroad 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 OAuth Authentication

To authenticate to Gumroad and connect to your own data or to allow other users to connect to their data, you can use the OAuth 2.0 standard. This is the recommended authentication method.

First you need to register an OAuth application with Gumroad. You can create an OAuth application by visiting your Gumroad account settings at https://app.gumroad.com/settings/advanced and navigating to the Applications section.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to OAuth.
• InitiateOAuth: Set this to GETANDREFRESH. The CData API Profile for Gumroad will automatically walk through the OAuth process in order to obtain the access token.
• OAuthClientID: Set this to the client_id that is specified in your app settings.
• OAuthClientSecret: Set this to the client_secret that is specified in your app settings.
• CallbackURL: Set this to the Redirect URI you specified in your app settings.

Example connection string

Profile=C:\profiles\Gumroad.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Building node-odbc

In order to connect to Gumroad through the CData ODBC Driver, you need to build node-odbc manually (after installing the required tools).

Installing the Required Tools

The following commands install the tools required to build node-odbc (note the -g parameter, which installs the tools globally).

npm i -g windows-build-tools
npm i -g node-gyp

Building node-odbc

After installing the required tools, create a directory for the Node.js app and install odbc (which builds the binary for us to use in our Node.js script).

mkdir nodeodbc
cd nodeodbc
npm i -g node

Querying Gumroad from Node.js

With the ODBC Driver installed, a DSN Configured, and node-odbc built, we are ready to query live Gumroad data from a Node.js app. The sample code below connects to a specific DSN and queries the CustomFields table.

myscript.js

const odbc = require('odbc');

async function queryAPI() {
    const connection = await odbc.connect(`DSN=CData API Source`);
    const data = await connection.query('SELECT ,  FROM CustomFields');
    console.log(data);
}

queryAPI();

Once you write the app, use node to execute the script:

node myscript.js

Download a free, 30-day trial of the CData API Driver for ODBC and start working with your live Gumroad data in Node.js. Reach out to our Support Team if you have any questions.