PowerBuilder

QuickBooks - Automatically Refresh Access Token with No User Interaction

See more QuickBooks Examples

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

integer li_rc
integer li_Success
oleobject loo_JsonToken
oleobject loo_Rest
integer li_BAutoReconnect
oleobject loo_SbAuth
string ls_ResponseBody
oleobject loo_Oauth2
oleobject loo_SbJson
oleobject loo_Json
oleobject loo_Dtime
integer li_BLocalTime
oleobject loo_Dt

li_Success = 0

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

loo_JsonToken = create oleobject
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat.JsonObject")
if li_rc < 0 then
    destroy loo_JsonToken
    MessageBox("Error","Connecting to COM object failed")
    return
end if
li_Success = loo_JsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")

// 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.
li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("sandbox-quickbooks.api.intuit.com",443,1,li_BAutoReconnect)
if li_Success = 0 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_JsonToken
    destroy loo_Rest
    return
end if

loo_SbAuth = create oleobject
li_rc = loo_SbAuth.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbAuth.Append("Bearer ")
loo_SbAuth.Append(loo_JsonToken.StringOf("access_token"))
loo_Rest.Authorization = loo_SbAuth.GetAsString()

loo_Rest.AddHeader("Accept","application/json")
loo_Rest.AllowHeaderFolding = 0

// The company ID is 123146096291789
// The employee ID is 58
ls_ResponseBody = loo_Rest.FullRequestNoBody("GET","/v3/company/123146096291789/employee/58?minorversion=45")
if loo_Rest.LastMethodSuccess = 0 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_JsonToken
    destroy loo_Rest
    destroy loo_SbAuth
    return
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 loo_Rest.ResponseStatusCode = 401 then

    loo_Oauth2 = create oleobject
    li_rc = loo_Oauth2.ConnectToNewObject("Chilkat.OAuth2")

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

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

    // Get the "refresh_token"
    loo_Oauth2.RefreshToken = loo_JsonToken.StringOf("refresh_token")

    // Send the HTTP POST to refresh the access token..
    li_Success = loo_Oauth2.RefreshAccessToken()
    if li_Success = 0 then
        Write-Debug loo_Oauth2.LastErrorText
        destroy loo_JsonToken
        destroy loo_Rest
        destroy loo_SbAuth
        destroy loo_Oauth2
        return
    end if

    Write-Debug "New access token: " + loo_Oauth2.AccessToken

    // Update the JSON with the new tokens.
    loo_JsonToken.UpdateString("access_token",loo_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.
    loo_SbJson = create oleobject
    li_rc = loo_SbJson.ConnectToNewObject("Chilkat.StringBuilder")

    loo_JsonToken.EmitCompact = 0
    loo_JsonToken.EmitSb(loo_SbJson)
    loo_SbJson.WriteFile("qa_data/tokens/qb-access-token.json","utf-8",0)

    Write-Debug "OAuth2 token refreshed!"
    Write-Debug "New Access Token = " + loo_Oauth2.AccessToken

    loo_SbAuth.Clear()
    loo_SbAuth.Append("Bearer ")
    loo_SbAuth.Append(loo_Oauth2.AccessToken)
    loo_Rest.Authorization = loo_SbAuth.GetAsString()

    // Now retry the request with the refreshed access token...
    ls_ResponseBody = loo_Rest.FullRequestNoBody("GET","/v3/company/123146096291789/employee/58?minorversion=45")
    if loo_Rest.LastMethodSuccess = 0 then
        Write-Debug loo_Rest.LastErrorText
        destroy loo_JsonToken
        destroy loo_Rest
        destroy loo_SbAuth
        destroy loo_Oauth2
        destroy loo_SbJson
        return
    end if

end if

// We should expect a 200 response if successful.
if loo_Rest.ResponseStatusCode <> 200 then
    Write-Debug "Request Header: "
    Write-Debug loo_Rest.LastRequestHeader
    Write-Debug "----"
    Write-Debug "Response StatusCode = " + string(loo_Rest.ResponseStatusCode)
    Write-Debug "Response StatusLine: " + loo_Rest.ResponseStatusText
    Write-Debug "Response Header:"
    Write-Debug loo_Rest.ResponseHeader
    Write-Debug ls_ResponseBody
    destroy loo_JsonToken
    destroy loo_Rest
    destroy loo_SbAuth
    destroy loo_Oauth2
    destroy loo_SbJson
    return
end if

// Load the JSON response into a JSON object for parsing.
// A sample JSON response is shown below.
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.Load(ls_ResponseBody)

// These will be used for parsing date/time strings..
loo_Dtime = create oleobject
li_rc = loo_Dtime.ConnectToNewObject("Chilkat.CkDateTime")

li_BLocalTime = 1

// Show the JSON.   
loo_Json.EmitCompact = 0
Write-Debug loo_Json.Emit()

// Get some information from the JSON..
Write-Debug "Name: " + loo_Json.StringOf("Employee.DisplayName")
Write-Debug "Id: " + loo_Json.StringOf("Employee.Id")
Write-Debug "City: " + loo_Json.StringOf("Employee.PrimaryAddr.City")
Write-Debug "PostalCode: " + loo_Json.StringOf("Employee.PrimaryAddr.PostalCode")

// Load the CreateTime into a CkDateTime...
loo_Dtime.SetFromTimestamp(loo_Json.StringOf("Employee.MetaData.CreateTime"))
loo_Dt = create oleobject
li_rc = loo_Dt.ConnectToNewObject("Chilkat.DtObj")

loo_Dtime.ToDtObj(li_BLocalTime,loo_Dt)

Write-Debug string(loo_Dt.Month) + "/" + string(loo_Dt.Day) + "/" + string(loo_Dt.Year) + "  " + string(loo_Dt.Hour) + ":" + string(loo_Dt.Minute)

Write-Debug "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"
// 


destroy loo_JsonToken
destroy loo_Rest
destroy loo_SbAuth
destroy loo_Oauth2
destroy loo_SbJson
destroy loo_Json
destroy loo_Dtime
destroy loo_Dt