Query Keap Data as a MySQL Database in Node.js

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

Start by setting the Profile connection property to the location of the Keap Profile on disk (e.g. C:\profiles\Keap.apip). Next, set the ProfileSettings connection property to the connection string for Keap (see below).

Keap API Profile Settings

Log into your Keap web app, click the user bubble in the bottom left, choose Settings > API, then generate a new Personal Access Token or Service Account Key.

Configure the SQL Gateway

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

The following example shows how to define a connection and execute queries to Keap 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 Keap 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 Account', function(err, rows, fields) {
  if (err) throw err;
  console.log(rows);
});

connection.end();