(Excel) 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 v9.5.0.64 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.

Download Excel Class Modules Chilkat Excel Class Modules

' This example requires Chilkat v9.5.0.64 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.
Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest


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.
Dim pfx As Chilkat.Pfx
Set pfx = Chilkat.NewPfx

success = pfx.LoadPfxFile("qa_data/certs/xero_private_app/public_privatekey.pfx","PFX_PASSWORD")
If (success <> True) Then
    Debug.Print pfx.LastErrorText
    Exit Sub
End If


Set privKeyFromPfx = pfx.GetPrivateKey(0)
If (pfx.LastMethodSuccess <> True) Then
    Debug.Print pfx.LastErrorText
    Exit Sub
End If

' Or we can load from a PEM..
Dim privKeyFromPem As Chilkat.PrivateKey
Set privKeyFromPem = Chilkat.NewPrivateKey
success = privKeyFromPem.LoadPemFile("qa_data/certs/xero_private_app/privatekey.pem")
If (success <> True) Then
    Debug.Print privKeyFromPem.LastErrorText
    Exit Sub
End If

' Note: There are many other means for loading a private key, including
' from other formats and directly from memory (i.e. not file-based).

Dim oauth1 As Chilkat.OAuth1
Set oauth1 = Chilkat.NewOAuth1
oauth1.ConsumerKey = consumerKey
oauth1.ConsumerSecret = consumerSecret
oauth1.Token = consumerKey
oauth1.TokenSecret = consumerSecret
oauth1.SignatureMethod = "RSA-SHA1"
success = 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) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

' Finally, install the OAuth1 authenticator.
' (It make no difference whether this happens before or after the
' connection is established.)
success = rest.SetAuthOAuth1(oauth1,False)

Debug.Print "OK, the Xero OAuth1 is initialized and the REST object is ready to make REST API calls.."