Query Xero Data as a MySQL Database in Node.js

You can use the SQL Gateway from the ODBC Driver for Xero to query Xero 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.

Getting Started

---

Connect to Xero 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.

To connect, set the Schema connection property in addition to any authentication values. Xero offers authentication for private applications, public applications, and partner applications. You will need to set the XeroAppAuthentication property to PUBLIC, PRIVATE, or PARTNER, depending on the type of application configured. To connect from a private application, you will additionally need to set the OAuthAccessToken, OAuthClientId, OAuthClientSecret, CertificateStoreType, CertificateStore, and CertificateStorePassword.

To connect from a public or partner application, you can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL, or you can register an app to obtain your own OAuth values.

See the "Getting Started" chapter of the help documentation for a guide to authenticating to Xero.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Xero 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 Xero from Node.js

The following example shows how to define a connection and execute queries to Xero 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 Xero data and start executing queries with the code below:

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

connection.end();