(Tcl) 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.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# 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.
set rest [new_CkRest]

set consumerKey "XERO_PRIVATE_APP_KEY"
set 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.
set pfx [new_CkPfx]

set success [CkPfx_LoadPfxFile $pfx "qa_data/certs/xero_private_app/public_privatekey.pfx" "PFX_PASSWORD"]
if {$success != 1} then {
    puts [CkPfx_lastErrorText $pfx]
    delete_CkRest $rest
    delete_CkPfx $pfx
    exit
}

# privKeyFromPfx is a CkPrivateKey
set privKeyFromPfx [CkPfx_GetPrivateKey $pfx 0]
if {[CkPfx_get_LastMethodSuccess $pfx] != 1} then {
    puts [CkPfx_lastErrorText $pfx]
    delete_CkRest $rest
    delete_CkPfx $pfx
    exit
}

# Or we can load from a PEM..
set privKeyFromPem [new_CkPrivateKey]

set success [CkPrivateKey_LoadPemFile $privKeyFromPem "qa_data/certs/xero_private_app/privatekey.pem"]
if {$success != 1} then {
    puts [CkPrivateKey_lastErrorText $privKeyFromPem]
    delete_CkRest $rest
    delete_CkPfx $pfx
    delete_CkPrivateKey $privKeyFromPem
    exit
}

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

set oauth1 [new_CkOAuth1]

CkOAuth1_put_ConsumerKey $oauth1 $consumerKey
CkOAuth1_put_ConsumerSecret $oauth1 $consumerSecret
CkOAuth1_put_Token $oauth1 $consumerKey
CkOAuth1_put_TokenSecret $oauth1 $consumerSecret
CkOAuth1_put_SignatureMethod $oauth1 "RSA-SHA1"
CkOAuth1_SetRsaKey $oauth1 $privKeyFromPfx
delete_CkPrivateKey $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.
set bAutoReconnect 1
set success [CkRest_Connect $rest "api.xero.com" 443 1 $bAutoReconnect]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkPfx $pfx
    delete_CkPrivateKey $privKeyFromPem
    delete_CkOAuth1 $oauth1
    exit
}

# Finally, install the OAuth1 authenticator.
# (It make no difference whether this happens before or after the
# connection is established.)
CkRest_SetAuthOAuth1 $rest $oauth1 0

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

delete_CkRest $rest
delete_CkPfx $pfx
delete_CkPrivateKey $privKeyFromPem
delete_CkOAuth1 $oauth1