(Excel) QuickBooks - Automatically Refresh Access Token with No User Interaction

Demonstrates how to automaticaly refresh an expired access token and retry the request after a 401 authorization error.

Download Excel Class Modules Chilkat Excel Class Modules

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

' Get our previously obtained OAuth2 access token, which should contain JSON like this:
' {
'   "expires_in": 3600,
'   "x_refresh_token_expires_in": 8726400,
'   "refresh_token": "L011546037639r ... 3vR2DrbOmg0Sdagw",
'   "access_token": "eyJlbmMiOiJBMTI4Q0 ... oETJEMbeggg",
'   "token_type": "bearer"
' }

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

success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest

' Connect using TLS.
' A single REST object, once connected, can be used for many Quickbooks 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("sandbox-quickbooks.api.intuit.com",443,True,bAutoReconnect)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

Dim sbAuth As Chilkat.StringBuilder
Set sbAuth = Chilkat.NewStringBuilder
Dim success As Boolean
success = sbAuth.Append("Bearer ")
success = sbAuth.Append(jsonToken.StringOf("access_token"))
rest.Authorization = sbAuth.GetAsString()

success = rest.AddHeader("Accept","application/json")
rest.AllowHeaderFolding = False

' The company ID is 123146096291789
' The employee ID is 58

responseBody = rest.FullRequestNoBody("GET","/v3/company/123146096291789/employee/58?minorversion=45")
If (rest.LastMethodSuccess <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

' If we get a 401 authorization error, then it's likely because the access token expired.
' We can automatically refresh it without interaction from the user.
If (rest.ResponseStatusCode = 401) Then

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

    oauth2.TokenEndpoint = "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"

    ' Replace these with actual values.
    oauth2.ClientId = "QUICKBOOKS-CLIENT-ID"
    oauth2.ClientSecret = "QUICKBOOKS-CLIENT-SECRET"

    ' 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 "New access token: "; oauth2.AccessToken

    ' Update the JSON with the new tokens.
    success = jsonToken.UpdateString("access_token",oauth2.AccessToken)

    ' Save the new JSON access token response to a file.
    ' The access + refresh tokens contained in this JSON will be needed for the next refresh.
    Dim sbJson As Chilkat.StringBuilder
    Set sbJson = Chilkat.NewStringBuilder
    jsonToken.EmitCompact = False
    success = jsonToken.EmitSb(sbJson)
    success = sbJson.WriteFile("qa_data/tokens/qb-access-token.json","utf-8",False)

    Debug.Print "OAuth2 token refreshed!"
    Debug.Print "New Access Token = "; oauth2.AccessToken

    sbAuth.Clear 
    success = sbAuth.Append("Bearer ")
    success = sbAuth.Append(oauth2.AccessToken)
    rest.Authorization = sbAuth.GetAsString()

    ' Now retry the request with the refreshed access token...
    responseBody = rest.FullRequestNoBody("GET","/v3/company/123146096291789/employee/58?minorversion=45")
    If (rest.LastMethodSuccess <> True) Then
        Debug.Print rest.LastErrorText
        Exit Sub
    End If

End If

' We should expect a 200 response if successful.
If (rest.ResponseStatusCode <> 200) Then
    Debug.Print "Request Header: "
    Debug.Print rest.LastRequestHeader
    Debug.Print "----"
    Debug.Print "Response StatusCode = "; rest.ResponseStatusCode
    Debug.Print "Response StatusLine: "; rest.ResponseStatusText
    Debug.Print "Response Header:"
    Debug.Print rest.ResponseHeader
    Debug.Print responseBody
    Exit Sub
End If

' Load the JSON response into a JSON object for parsing.
' A sample JSON response is shown below.
Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
success = json.Load(responseBody)

' These will be used for parsing date/time strings..
Dim dtime As Chilkat.CkDateTime
Set dtime = Chilkat.NewCkDateTime

bLocalTime = True

' Show the JSON.   
json.EmitCompact = False
Debug.Print json.Emit()

' Get some information from the JSON..
Debug.Print "Name: "; json.StringOf("Employee.DisplayName")
Debug.Print "Id: "; json.StringOf("Employee.Id")
Debug.Print "City: "; json.StringOf("Employee.PrimaryAddr.City")
Debug.Print "PostalCode: "; json.StringOf("Employee.PrimaryAddr.PostalCode")

' Load the CreateTime into a CkDateTime...
success = dtime.SetFromTimestamp(json.StringOf("Employee.MetaData.CreateTime"))
Set dt = dtime.GetDtObj(bLocalTime)
Debug.Print dt.Month; "/"; dt.Day; "/"; dt.Year; "  "; dt.Hour; ":"; dt.Minute

Debug.Print "Success."

' Use this online tool to generate parsing code from sample JSON: 
' Generate Parsing Code from JSON

' ------------------------------------------------------
' The JSON response looks like this:

' {
'   "Employee": {
'     "SSN": "XXX-XX-XXXX",
'     "PrimaryAddr": {
'       "Id": "116",
'       "Line1": "45 N. Elm Street",
'       "City": "Middlefield",
'       "CountrySubDivisionCode": "CA",
'       "PostalCode": "93242"
'     },
'     "BillableTime": false,
'     "domain": "QBO",
'     "sparse": false,
'     "Id": "98",
'     "SyncToken": "0",
'     "MetaData": {
'       "CreateTime": "2015-07-24T09:34:35-07:00",
'       "LastUpdatedTime": "2015-07-24T09:34:35-07:00"
'     },
'     "GivenName": "Bill",
'     "FamilyName": "Miller",
'     "DisplayName": "Bill Miller",
'     "PrintOnCheckName": "Bill Miller",
'     "Active": true,
'     "PrimaryPhone": {
'       "FreeFormNumber": "234-525-1234"
'     }
'   },
'   "time": "2015-07-24T09:35:54.805-07:00"
'