Chilkat HOME Android™ Classic ASP C C++ C# Mono C# .NET Core C# C# UWP/WinRT DataFlex Delphi ActiveX Delphi DLL Visual FoxPro Java Lianja MFC Objective-C Perl PHP ActiveX PHP Extension PowerBuilder PowerShell PureBasic CkPython Chilkat2-Python Ruby SQL Server Swift 2 Swift 3/4 Tcl Unicode C Unicode C++ Visual Basic 6.0 VB.NET VB.NET UWP/WinRT VBScript Xojo Plugin Node.js Excel Go
(Ruby) Xero 2 Legged OAuth for Private Application
This example demonstrates the REST object for 2-legged OAuth for a private application.
Note: This example requires Chilkat v22.214.171.124 or later.
An application can setup OAuth1 for a given instance of the Chilkat REST object, and then use the instance for many REST API calls. This example demonstrates the OAuth1 setup and initial connection. This code would typically be placed in a subroutine/function to "initalize" the REST object before beginning to use it for REST HTTP requests.
Note: Xero private applications use 2 legged OAuth and bypass the user authorization workflow in the standard OAuth process. Private applications are linked to a single Xero organisation which is chosen when you register your application. In summary: 2-legged OAuth1 is for applications that access the data that they themselves own.
require 'chilkat' # This example requires Chilkat v126.96.36.199 or later # 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 = Chilkat::CkRest.new() 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 = Chilkat::CkPfx.new() success = pfx.LoadPfxFile("qa_data/certs/xero_private_app/public_privatekey.pfx","PFX_PASSWORD") if (success != true) print pfx.lastErrorText() + "\n"; exit end # privKeyFromPfx is a CkPrivateKey privKeyFromPfx = pfx.GetPrivateKey(0) if (pfx.get_LastMethodSuccess() != true) print pfx.lastErrorText() + "\n"; exit end # Or we can load from a PEM.. privKeyFromPem = Chilkat::CkPrivateKey.new() success = privKeyFromPem.LoadPemFile("qa_data/certs/xero_private_app/privatekey.pem") if (success != true) print privKeyFromPem.lastErrorText() + "\n"; 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 = Chilkat::CkOAuth1.new() oauth1.put_ConsumerKey(consumerKey) oauth1.put_ConsumerSecret(consumerSecret) oauth1.put_Token(consumerKey) oauth1.put_TokenSecret(consumerSecret) oauth1.put_SignatureMethod("RSA-SHA1") oauth1.SetRsaKey(privKeyFromPfx) # Make the initial connection. # A single REST object, once connected, can be used for many Xero REST API calls. # The auto-reconnect indicates that if the already-established HTTPS connection is closed, # then it will be automatically re-established as needed. bAutoReconnect = true success = rest.Connect("api.xero.com",443,true,bAutoReconnect) if (success != true) print rest.lastErrorText() + "\n"; exit end # Finally, install the OAuth1 authenticator. # (It make no difference whether this happens before or after the # connection is established.) rest.SetAuthOAuth1(oauth1,false) print "OK, the Xero OAuth1 is initialized and the REST object is ready to make REST API calls.." + "\n";
© 2000-2020 Chilkat Software, Inc. All Rights Reserved.