Node.js Requires Chilkat v11.0.0+
Node.js
Xero API through an SSH Tunnel
This example demonstrates connecting through an SSH Tunnel w/ 2-legged OAuth for a Xero private application.Chilkat Node.js Downloads
NODEJS_PRELUDE
function chilkatExample() {
var success = false;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var tunnel = new chilkat.Socket();
var sshHostname = "sftp.example.com";
var sshPort = 22;
// Connect to an SSH server and establish the SSH tunnel:
success = tunnel.SshOpenTunnel(sshHostname,sshPort);
if (success == false) {
console.log(tunnel.LastErrorText);
return;
}
// Authenticate with the SSH server via a login/password
// or with a public key.
// This example demonstrates SSH password authentication.
success = tunnel.SshAuthenticatePw("mySshLogin","mySshPassword");
if (success == false) {
console.log(tunnel.LastErrorText);
return;
}
// OK, the SSH tunnel is setup. Now open a channel within the tunnel.
// (Any number of channels may be created from the same SSH tunnel.
// Multiple channels may coexist at the same time.)
// This sample code would typically be placed in a subroutine or function
// where the rest object is passed by reference.
// It does the OAuth1 setup and makes the initial connection.
var rest = new chilkat.Rest();
var bTls = true;
var port = 443;
var maxWaitMs = 7000;
// This returns a socket object that is a single channel within the SSH tunnel.
var channel = new chilkat.Socket();
success = tunnel.SshNewChannel("api.xero.com",port,bTls,maxWaitMs,channel);
if (success == false) {
console.log(tunnel.LastErrorText);
return;
}
// Use the connection. (This connection is a TLS running on an SSH channel through an SSH tunnel.
// In other words, TLS is wrapped within the SSH tunnel.)
success = rest.UseConnection(channel,true);
if (success == false) {
console.log(rest.LastErrorText);
return;
}
// OK, we're connected.
// -----------------------------------------------------------------
// Now setup the OAuth1 authenticator..
var consumerKey = "XERO_PRIVATE_APP_KEY";
var consumerSecret = "XERO_PRIVATE_APP_SECRET";
// Let's get our private key from our PFX (password protected), or the PEM (unprotected).
// You can decide which to use. Either is OK, although I would recommend keeping your
// private keys in a PFX and not in an unprotected PEM.
var pfx = new chilkat.Pfx();
success = pfx.LoadPfxFile("qa_data/certs/xero_private_app/public_privatekey.pfx","PFX_PASSWORD");
if (success == false) {
console.log(pfx.LastErrorText);
return;
}
var privKeyFromPfx = new chilkat.PrivateKey();
success = pfx.PrivateKeyAt(0,privKeyFromPfx);
if (success == false) {
console.log(pfx.LastErrorText);
return;
}
// Or we can load from a PEM..
var privKeyFromPem = new chilkat.PrivateKey();
success = privKeyFromPem.LoadPemFile("qa_data/certs/xero_private_app/privatekey.pem");
if (success == false) {
console.log(privKeyFromPem.LastErrorText);
return;
}
// Note: There are many other means for loading a private key, including
// from other formats and directly from memory (i.e. not file-based).
var oauth1 = new chilkat.OAuth1();
oauth1.ConsumerKey = consumerKey;
oauth1.ConsumerSecret = consumerSecret;
oauth1.Token = consumerKey;
oauth1.TokenSecret = consumerSecret;
oauth1.SignatureMethod = "RSA-SHA1";
oauth1.SetRsaKey(privKeyFromPfx);
// Install the OAuth1 authenticator.
rest.SetAuthOAuth1(oauth1,false);
console.log("OK, the Xero OAuth1 is initialized and the REST object is ready to make REST API calls..");
// -----------------------------------------------------------------
// Make a call to verify that OAuth1 through an HTTP proxy works..
// Get the full list of contacts.
var sbXml = new chilkat.StringBuilder();
success = rest.FullRequestNoBodySb("GET","/api.xro/2.0/Contacts",sbXml);
if (success == false) {
console.log(rest.LastErrorText);
return;
}
// A 200 response is expected for actual success.
if (rest.ResponseStatusCode !== 200) {
console.log(sbXml.GetAsString());
return;
}
// Iterate over the contacts..
var bAutoTrim = false;
var xml = new chilkat.Xml();
xml.LoadSb(sbXml,bAutoTrim);
xml.SaveXml("qa_cache/xero_contacts.xml");
// How many records exist?
var recordCount = xml.NumChildrenAt("Contacts");
console.log("numRecords = " + recordCount);
var i = 0;
while (i < recordCount) {
xml.I = i;
console.log("ContactID: " + xml.GetChildContent("Contacts|Contact[i]|ContactID"));
i = i+1;
}
}
chilkatExample();