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

Chilkat Lianja Extension Download Chilkat Lianja Extension

// 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"
// }

loJsonToken = createobject("CkJsonObject")
llSuccess = loJsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

loRest = createobject("CkRest")

// 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.
llBAutoReconnect = .T.
llSuccess = loRest.Connect("sandbox-quickbooks.api.intuit.com",443,.T.,llBAutoReconnect)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loRest
    return
endif

loSbAuth = createobject("CkStringBuilder")
loSbAuth.Append("Bearer ")
loSbAuth.Append(loJsonToken.StringOf("access_token"))
loRest.Authorization = loSbAuth.GetAsString()

loRest.AddHeader("Accept","application/json")
loRest.AllowHeaderFolding = .F.

// The company ID is 123146096291789
// The employee ID is 58
lcResponseBody = loRest.FullRequestNoBody("GET","/v3/company/123146096291789/employee/58?minorversion=45")
if (loRest.LastMethodSuccess <> .T.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loRest
    release loSbAuth
    return
endif

// 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 (loRest.ResponseStatusCode = 401) then

    loOauth2 = createobject("CkOAuth2")

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

    // Replace these with actual values.
    loOauth2.ClientId = "QUICKBOOKS-CLIENT-ID"
    loOauth2.ClientSecret = "QUICKBOOKS-CLIENT-SECRET"

    // Get the "refresh_token"
    loOauth2.RefreshToken = loJsonToken.StringOf("refresh_token")

    // Send the HTTP POST to refresh the access token..
    llSuccess = loOauth2.RefreshAccessToken()
    if (llSuccess <> .T.) then
        ? loOauth2.LastErrorText
        release loJsonToken
        release loRest
        release loSbAuth
        release loOauth2
        return
    endif

    ? "New access token: " + loOauth2.AccessToken

    // Update the JSON with the new tokens.
    loJsonToken.UpdateString("access_token",loOauth2.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.
    loSbJson = createobject("CkStringBuilder")
    loJsonToken.EmitCompact = .F.
    loJsonToken.EmitSb(loSbJson)
    loSbJson.WriteFile("qa_data/tokens/qb-access-token.json","utf-8",.F.)

    ? "OAuth2 token refreshed!"
    ? "New Access Token = " + loOauth2.AccessToken

    loSbAuth.Clear()
    loSbAuth.Append("Bearer ")
    loSbAuth.Append(loOauth2.AccessToken)
    loRest.Authorization = loSbAuth.GetAsString()

    // Now retry the request with the refreshed access token...
    lcResponseBody = loRest.FullRequestNoBody("GET","/v3/company/123146096291789/employee/58?minorversion=45")
    if (loRest.LastMethodSuccess <> .T.) then
        ? loRest.LastErrorText
        release loJsonToken
        release loRest
        release loSbAuth
        release loOauth2
        release loSbJson
        return
    endif

endif

// We should expect a 200 response if successful.
if (loRest.ResponseStatusCode <> 200) then
    ? "Request Header: "
    ? loRest.LastRequestHeader
    ? "----"
    ? "Response StatusCode = " + str(loRest.ResponseStatusCode)
    ? "Response StatusLine: " + loRest.ResponseStatusText
    ? "Response Header:"
    ? loRest.ResponseHeader
    ? lcResponseBody
    release loJsonToken
    release loRest
    release loSbAuth
    release loOauth2
    release loSbJson
    return
endif

// Load the JSON response into a JSON object for parsing.
// A sample JSON response is shown below.
loJson = createobject("CkJsonObject")
loJson.Load(lcResponseBody)

// These will be used for parsing date/time strings..
loDtime = createobject("CkDateTime")
llBLocalTime = .T.

// Show the JSON.   
loJson.EmitCompact = .F.
? loJson.Emit()

// Get some information from the JSON..
? "Name: " + loJson.StringOf("Employee.DisplayName")
? "Id: " + loJson.StringOf("Employee.Id")
? "City: " + loJson.StringOf("Employee.PrimaryAddr.City")
? "PostalCode: " + loJson.StringOf("Employee.PrimaryAddr.PostalCode")

// Load the CreateTime into a CkDateTime...
loDtime.SetFromTimestamp(loJson.StringOf("Employee.MetaData.CreateTime"))
loDt = loDtime.GetDtObj(llBLocalTime)
? str(loDt.Month) + "/" + str(loDt.Day) + "/" + str(loDt.Year) + "  " + str(loDt.Hour) + ":" + str(loDt.Minute)
release loDt

? "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"
// 


release loJsonToken
release loRest
release loSbAuth
release loOauth2
release loSbJson
release loJson
release loDtime