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
(PureBasic) 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
IncludeFile "CkPrivateKey.pb" IncludeFile "CkSocket.pb" IncludeFile "CkXml.pb" IncludeFile "CkPfx.pb" IncludeFile "CkStringBuilder.pb" IncludeFile "CkRest.pb" IncludeFile "CkOAuth1.pb" Procedure ChilkatExample() ; This example requires Chilkat v9.5.0.64 or later tunnel.i = CkSocket::ckCreate() If tunnel.i = 0 Debug "Failed to create object." ProcedureReturn EndIf sshHostname.s = "www.my-ssh-server.com" sshPort.i = 22 ; Connect to an SSH server and establish the SSH tunnel: success.i = CkSocket::ckSshOpenTunnel(tunnel,sshHostname,sshPort) If success <> 1 Debug CkSocket::ckLastErrorText(tunnel) CkSocket::ckDispose(tunnel) ProcedureReturn EndIf ; Authenticate with the SSH server via a login/password ; or with a public key. ; This example demonstrates SSH password authentication. success = CkSocket::ckSshAuthenticatePw(tunnel,"mySshLogin","mySshPassword") If success <> 1 Debug CkSocket::ckLastErrorText(tunnel) CkSocket::ckDispose(tunnel) ProcedureReturn EndIf ; 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. rest.i = CkRest::ckCreate() If rest.i = 0 Debug "Failed to create object." ProcedureReturn EndIf channel.i bTls.i = 1 port.i = 443 maxWaitMs.i = 7000 ; This returns a socket object that is a single channel within the SSH tunnel. channel = CkSocket::ckSshOpenChannel(tunnel,"api.xero.com",port,bTls,maxWaitMs) If CkSocket::ckLastMethodSuccess(tunnel) <> 1 Debug CkSocket::ckLastErrorText(tunnel) CkSocket::ckDispose(tunnel) CkRest::ckDispose(rest) ProcedureReturn EndIf ; 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 = CkRest::ckUseConnection(rest,channel,1) If success <> 1 Debug CkRest::ckLastErrorText(rest) CkSocket::ckDispose(channel) CkSocket::ckDispose(tunnel) CkRest::ckDispose(rest) ProcedureReturn EndIf ; OK, we're connected. ; ----------------------------------------------------------------- ; Now setup the OAuth1 authenticator.. consumerKey.s = "XERO_PRIVATE_APP_KEY" consumerSecret.s = "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. pfx.i = CkPfx::ckCreate() If pfx.i = 0 Debug "Failed to create object." ProcedureReturn EndIf success = CkPfx::ckLoadPfxFile(pfx,"qa_data/certs/xero_private_app/public_privatekey.pfx","PFX_PASSWORD") If success <> 1 Debug CkPfx::ckLastErrorText(pfx) CkSocket::ckDispose(tunnel) CkRest::ckDispose(rest) CkPfx::ckDispose(pfx) ProcedureReturn EndIf privKeyFromPfx.i = CkPfx::ckGetPrivateKey(pfx,0) If CkPfx::ckLastMethodSuccess(pfx) <> 1 Debug CkPfx::ckLastErrorText(pfx) CkSocket::ckDispose(tunnel) CkRest::ckDispose(rest) CkPfx::ckDispose(pfx) ProcedureReturn EndIf ; Or we can load from a PEM.. privKeyFromPem.i = CkPrivateKey::ckCreate() If privKeyFromPem.i = 0 Debug "Failed to create object." ProcedureReturn EndIf success = CkPrivateKey::ckLoadPemFile(privKeyFromPem,"qa_data/certs/xero_private_app/privatekey.pem") If success <> 1 Debug CkPrivateKey::ckLastErrorText(privKeyFromPem) CkSocket::ckDispose(tunnel) CkRest::ckDispose(rest) CkPfx::ckDispose(pfx) CkPrivateKey::ckDispose(privKeyFromPem) ProcedureReturn EndIf ; Note: There are many other means for loading a private key, including ; from other formats and directly from memory (i.e. not file-based). oauth1.i = CkOAuth1::ckCreate() If oauth1.i = 0 Debug "Failed to create object." ProcedureReturn EndIf CkOAuth1::setCkConsumerKey(oauth1, consumerKey) CkOAuth1::setCkConsumerSecret(oauth1, consumerSecret) CkOAuth1::setCkToken(oauth1, consumerKey) CkOAuth1::setCkTokenSecret(oauth1, consumerSecret) CkOAuth1::setCkSignatureMethod(oauth1, "RSA-SHA1") CkOAuth1::ckSetRsaKey(oauth1,privKeyFromPfx) CkPrivateKey::ckDispose(privKeyFromPfx) ; Install the OAuth1 authenticator. CkRest::ckSetAuthOAuth1(rest,oauth1,0) Debug "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. sbXml.i = CkStringBuilder::ckCreate() If sbXml.i = 0 Debug "Failed to create object." ProcedureReturn EndIf success = CkRest::ckFullRequestNoBodySb(rest,"GET","/api.xro/2.0/Contacts",sbXml) If success <> 1 Debug CkRest::ckLastErrorText(rest) CkSocket::ckDispose(tunnel) CkRest::ckDispose(rest) CkPfx::ckDispose(pfx) CkPrivateKey::ckDispose(privKeyFromPem) CkOAuth1::ckDispose(oauth1) CkStringBuilder::ckDispose(sbXml) ProcedureReturn EndIf ; A 200 response is expected for actual success. If CkRest::ckResponseStatusCode(rest) <> 200 Debug CkStringBuilder::ckGetAsString(sbXml) CkSocket::ckDispose(tunnel) CkRest::ckDispose(rest) CkPfx::ckDispose(pfx) CkPrivateKey::ckDispose(privKeyFromPem) CkOAuth1::ckDispose(oauth1) CkStringBuilder::ckDispose(sbXml) ProcedureReturn EndIf ; Iterate over the contacts.. bAutoTrim.i = 0 xml.i = CkXml::ckCreate() If xml.i = 0 Debug "Failed to create object." ProcedureReturn EndIf CkXml::ckLoadSb(xml,sbXml,bAutoTrim) CkXml::ckSaveXml(xml,"qa_cache/xero_contacts.xml") ; How many records exist? recordCount.i = CkXml::ckNumChildrenAt(xml,"Contacts") Debug "numRecords = " + Str(recordCount) i.i = 0 While i < recordCount CkXml::setCkI(xml, i) Debug "ContactID: " + CkXml::ckGetChildContent(xml,"Contacts|Contact[i]|ContactID") i = i + 1 Wend CkSocket::ckDispose(tunnel) CkRest::ckDispose(rest) CkPfx::ckDispose(pfx) CkPrivateKey::ckDispose(privKeyFromPem) CkOAuth1::ckDispose(oauth1) CkStringBuilder::ckDispose(sbXml) CkXml::ckDispose(xml) ProcedureReturn EndProcedure |
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.