Query BigCommerce Data as a SQL Server Database in Node.js

You can use CData Connect AI to query BigCommerce data through a SQL Server interface. Follow the procedure below to create a virtual database for BigCommerce in Connect AI and start querying using Node.js.

CData Connect AI provides a pure MySQL, cloud-to-cloud interface for BigCommerce, allowing you to easily query live BigCommerce data in Node.js — without replicating the data to a natively supported database. As you query data in Node.js, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc) directly to BigCommerce, leveraging server-side processing to quickly return BigCommerce data.

Configure BigCommerce Connectivity for NodeJS

Connectivity to BigCommerce from NodeJS is made possible through CData Connect AI. To work with BigCommerce data from NodeJS, we start by creating and configuring a BigCommerce connection.

1. Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection

2. Select "BigCommerce" from the Add Connection panel
👁 Selecting a data source

3. Enter the necessary authentication properties to connect to BigCommerce.

   BigCommerce authentication is based on the standard OAuth flow. To authenticate, you must initially create an app via the Big Commerce developer platform where you can obtain an OAuthClientId, OAuthClientSecret, and CallbackURL. These three parameters will be set as connection properties to your driver.

   Additionally, in order to connect to your BigCommerce Store, you will need your StoreId. To find your Store Id please follow these steps:

   1. Log in to your BigCommerce account.
   2. From the Home Page, select Advanced Settings > API Accounts.
   3. Click Create API Account.
   4. A text box named API Path will appear on your screen.
   5. Inside you can see a URL of the following structure: https://api.bigcommerce.com/stores/{Store Id}/v3.
   6. As demonstrated above, your Store Id will be between the 'stores/' and '/v3' path paramters.
   7. Once you have retrieved your Store Id you can either click Cancel or proceed in creating an API Account in case you do not have one already.
   👁 Configuring a connection (Salesforce is shown)
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add BigCommerce Connection page and update the User-based permissions. 👁 Updating permissions
   

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create. 👁 Creating a new PAT
   
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to BigCommerce data from Node.js.

Query BigCommerce from Node.js

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

• server: tds.cdata.com
• port: 14333
• user: a Connect AI user (e.g. [email protected])
• password: the PAT for the above user
• database: The connection you configured for BigCommerce (BigCommerce1)

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

var sql = require('mssql')
var config = {
	server: 'tds.cdata.com',
	port: 14333, 
	user: '[email protected]', //update me
	password: 'CONNECT_USER_PAT', //update me	
	options: {
		encrypt: true,
		database: 'BigCommerce1'
	}
}

sql.connect(config, err => { 
 if(err){
 throw err ;
 }
 new sql.Request().query('SELECT * FROM Customers', (err, result) => {
 console.dir(result)
 })
 
});

sql.on('error', err => {
 console.log("SQL Error: " ,err);
})