Chilkat HOME .NET Core C# Android™ AutoIt C C# C++ Chilkat2-Python CkPython Classic ASP DataFlex Delphi ActiveX Delphi DLL Go Java Lianja Mono C# Node.js Objective-C PHP ActiveX PHP Extension Perl PowerBuilder PowerShell PureBasic Ruby SQL Server Swift 2 Swift 3,4,5... Tcl Unicode C Unicode C++ VB.NET VBScript Visual Basic 6.0 Visual FoxPro Xojo Plugin
(Node.js) Xero API through an SSH TunnelThis example demonstrates connecting through an SSH Tunnel w/ 2-legged OAuth for a Xero private application. This example requires Chilkat v9.5.0.64 or later
var os = require('os'); if (os.platform() == 'win32') { if (os.arch() == 'ia32') { var chilkat = require('@chilkat/ck-node21-win-ia32'); } else { var chilkat = require('@chilkat/ck-node21-win64'); } } else if (os.platform() == 'linux') { if (os.arch() == 'arm') { var chilkat = require('@chilkat/ck-node21-arm'); } else if (os.arch() == 'x86') { var chilkat = require('@chilkat/ck-node21-linux32'); } else { var chilkat = require('@chilkat/ck-node21-linux64'); } } else if (os.platform() == 'darwin') { if (os.arch() == 'arm64') { var chilkat = require('@chilkat/ck-node21-mac-m1'); } else { var chilkat = require('@chilkat/ck-node21-macosx'); } } function chilkatExample() { // This example requires Chilkat v9.5.0.64 or later var tunnel = new chilkat.Socket(); var sshHostname = "sftp.example.com"; var sshPort = 22; // Connect to an SSH server and establish the SSH tunnel: var success = tunnel.SshOpenTunnel(sshHostname,sshPort); if (success !== true) { 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 !== true) { 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(); // channel: Socket var channel; var bTls = true; var port = 443; var maxWaitMs = 7000; // This returns a socket object that is a single channel within the SSH tunnel. channel = tunnel.SshOpenChannel("api.xero.com",port,bTls,maxWaitMs); if (tunnel.LastMethodSuccess !== true) { 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 !== true) { 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 !== true) { console.log(pfx.LastErrorText); return; } // privKeyFromPfx: PrivateKey var privKeyFromPfx = pfx.GetPrivateKey(0); if (pfx.LastMethodSuccess !== true) { 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 !== true) { 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 !== true) { 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(); |
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.