(Excel) Refresh a Xero OAuth2 Access Token

Refreshes a Xero OAuth2 access token. When an access token expires (after 1 hour), you will received a 401 status code indicating failure. When that happens, your application can run this code to refresh the access token, and then retry the request using the new access token. Refreshing an access token does not need user interaction (i.e. does not need to display a browser to have the user interactive authorize access).

Download Excel Class Modules Chilkat Excel Class Modules

' This example requires the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

' It is assumed we previously obtained an OAuth2 access token.
' This example loads the JSON access token file 
' saved by this example: Get Xero OAuth2 Access Token

Dim jsonToken As Chilkat.JsonObject
Set jsonToken = Chilkat.NewJsonObject

success = jsonToken.LoadFile("qa_data/tokens/xero-access-token.json")
If (success <> True) Then
    Debug.Print "Failed to load xero-access-token.json"
    Exit Sub
End If

' The access token JSON looks like this:

' {
'   "id_token": "eyJhbGci...dqRs3MctS_g",
'   "access_token": "eyJhbGci...sUoAhoQ",
'   "expires_in": 1800,
'   "token_type": "Bearer",
'   "refresh_token": "2f77b...bfc2ee16f",
'   "scope": "openid profile email accounting.transactions accounting.settings payroll.employees offline_access"
' }

Dim oauth2 As Chilkat.OAuth2
Set oauth2 = Chilkat.NewOAuth2

oauth2.TokenEndpoint = "https://identity.xero.com/connect/token"

' Replace these with actual values.
oauth2.ClientId = "XERO_APP_OAUTH2_CLIENT_ID"
oauth2.ClientSecret = "XERO_APP_OAUTH2_CLIENT_SECRET"
oauth2.UseBasicAuth = True

' Get the "refresh_token"
oauth2.RefreshToken = jsonToken.StringOf("refresh_token")

' Send the HTTP POST to refresh the access token..
success = oauth2.RefreshAccessToken()
If (success <> True) Then
    Debug.Print oauth2.LastErrorText
    Exit Sub
End If

Debug.Print oauth2.AccessTokenResponse

' The response contains a new access token and refresh token.
' Update the JSON and re-save to the token file.
Dim success As Boolean
success = jsonToken.UpdateString("access_token",oauth2.AccessToken)
success = jsonToken.UpdateString("refresh_token",oauth2.RefreshToken)

' Save the new JSON access token response to a file.
Dim sbJson As Chilkat.StringBuilder
Set sbJson = Chilkat.NewStringBuilder
jsonToken.EmitCompact = False
success = jsonToken.EmitSb(sbJson)
success = sbJson.WriteFile("qa_data/tokens/xero-access-token.json","utf-8",False)

Debug.Print "OAuth2 authorization granted!"
Debug.Print "New Access Token = "; oauth2.AccessToken