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
(Delphi DLL) 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
uses Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics, Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Socket, Rest, PrivateKey, OAuth1, StringBuilder, Pfx, Xml; ... procedure TForm1.Button1Click(Sender: TObject); var tunnel: HCkSocket; sshHostname: PWideChar; sshPort: Integer; success: Boolean; rest: HCkRest; channel: HCkSocket; bTls: Boolean; port: Integer; maxWaitMs: Integer; consumerKey: PWideChar; consumerSecret: PWideChar; pfx: HCkPfx; privKeyFromPfx: HCkPrivateKey; privKeyFromPem: HCkPrivateKey; oauth1: HCkOAuth1; sbXml: HCkStringBuilder; bAutoTrim: Boolean; xml: HCkXml; recordCount: Integer; i: Integer; begin // This example requires Chilkat v9.5.0.64 or later tunnel := CkSocket_Create(); sshHostname := 'www.my-ssh-server.com'; sshPort := 22; // Connect to an SSH server and establish the SSH tunnel: success := CkSocket_SshOpenTunnel(tunnel,sshHostname,sshPort); if (success <> True) then begin Memo1.Lines.Add(CkSocket__lastErrorText(tunnel)); Exit; end; // Authenticate with the SSH server via a login/password // or with a public key. // This example demonstrates SSH password authentication. success := CkSocket_SshAuthenticatePw(tunnel,'mySshLogin','mySshPassword'); if (success <> True) then begin Memo1.Lines.Add(CkSocket__lastErrorText(tunnel)); Exit; end; // 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 := CkRest_Create(); bTls := True; port := 443; maxWaitMs := 7000; // This returns a socket object that is a single channel within the SSH tunnel. channel := CkSocket_SshOpenChannel(tunnel,'api.xero.com',port,bTls,maxWaitMs); if (CkSocket_getLastMethodSuccess(tunnel) <> True) then begin Memo1.Lines.Add(CkSocket__lastErrorText(tunnel)); Exit; end; // 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_UseConnection(rest,channel,True); if (success <> True) then begin Memo1.Lines.Add(CkRest__lastErrorText(rest)); CkSocket_Dispose(channel); Exit; end; // OK, we're connected. // ----------------------------------------------------------------- // Now setup the OAuth1 authenticator.. consumerKey := 'XERO_PRIVATE_APP_KEY'; 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. pfx := CkPfx_Create(); success := CkPfx_LoadPfxFile(pfx,'qa_data/certs/xero_private_app/public_privatekey.pfx','PFX_PASSWORD'); if (success <> True) then begin Memo1.Lines.Add(CkPfx__lastErrorText(pfx)); Exit; end; privKeyFromPfx := CkPfx_GetPrivateKey(pfx,0); if (CkPfx_getLastMethodSuccess(pfx) <> True) then begin Memo1.Lines.Add(CkPfx__lastErrorText(pfx)); Exit; end; // Or we can load from a PEM.. privKeyFromPem := CkPrivateKey_Create(); success := CkPrivateKey_LoadPemFile(privKeyFromPem,'qa_data/certs/xero_private_app/privatekey.pem'); if (success <> True) then begin Memo1.Lines.Add(CkPrivateKey__lastErrorText(privKeyFromPem)); Exit; end; // 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 := CkOAuth1_Create(); CkOAuth1_putConsumerKey(oauth1,consumerKey); CkOAuth1_putConsumerSecret(oauth1,consumerSecret); CkOAuth1_putToken(oauth1,consumerKey); CkOAuth1_putTokenSecret(oauth1,consumerSecret); CkOAuth1_putSignatureMethod(oauth1,'RSA-SHA1'); CkOAuth1_SetRsaKey(oauth1,privKeyFromPfx); CkPrivateKey_Dispose(privKeyFromPfx); // Install the OAuth1 authenticator. CkRest_SetAuthOAuth1(rest,oauth1,False); Memo1.Lines.Add('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 := CkStringBuilder_Create(); success := CkRest_FullRequestNoBodySb(rest,'GET','/api.xro/2.0/Contacts',sbXml); if (success <> True) then begin Memo1.Lines.Add(CkRest__lastErrorText(rest)); Exit; end; // A 200 response is expected for actual success. if (CkRest_getResponseStatusCode(rest) <> 200) then begin Memo1.Lines.Add(CkStringBuilder__getAsString(sbXml)); Exit; end; // Iterate over the contacts.. bAutoTrim := False; xml := CkXml_Create(); CkXml_LoadSb(xml,sbXml,bAutoTrim); CkXml_SaveXml(xml,'qa_cache/xero_contacts.xml'); // How many records exist? recordCount := CkXml_NumChildrenAt(xml,'Contacts'); Memo1.Lines.Add('numRecords = ' + IntToStr(recordCount)); i := 0; while i < recordCount do begin CkXml_putI(xml,i); Memo1.Lines.Add('ContactID: ' + CkXml__getChildContent(xml,'Contacts|Contact[i]|ContactID')); i := i + 1; end; CkSocket_Dispose(tunnel); CkRest_Dispose(rest); CkPfx_Dispose(pfx); CkPrivateKey_Dispose(privKeyFromPem); CkOAuth1_Dispose(oauth1); CkStringBuilder_Dispose(sbXml); CkXml_Dispose(xml); end; |
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.