AutoIt

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. AutoIt

Local $bSuccess = False

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

$oJsonToken = ObjCreate("Chilkat.JsonObject")
$bSuccess = $oJsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

$oRest = ObjCreate("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.
Local $bAutoReconnect = True
$bSuccess = $oRest.Connect("sandbox-quickbooks.api.intuit.com",443,True,$bAutoReconnect)
If ($bSuccess = False) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

$oSbAuth = ObjCreate("Chilkat.StringBuilder")
$oSbAuth.Append("Bearer ")
$oSbAuth.Append($oJsonToken.StringOf("access_token"))
$oRest.Authorization = $oSbAuth.GetAsString()

$oRest.AddHeader("Accept","application/json")
$oRest.AllowHeaderFolding = False

; The company ID is 123146096291789
; The employee ID is 58
Local $sResponseBody = $oRest.FullRequestNoBody("GET","/v3/company/123146096291789/employee/58?minorversion=45")
If ($oRest.LastMethodSuccess = False) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
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 ($oRest.ResponseStatusCode = 401) Then

    $oOauth2 = ObjCreate("Chilkat.OAuth2")

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

    ; Replace these with actual values.
    $oOauth2.ClientId = "QUICKBOOKS-CLIENT-ID"
    $oOauth2.ClientSecret = "QUICKBOOKS-CLIENT-SECRET"

    ; Get the "refresh_token"
    $oOauth2.RefreshToken = $oJsonToken.StringOf("refresh_token")

    ; Send the HTTP POST to refresh the access token..
    $bSuccess = $oOauth2.RefreshAccessToken()
    If ($bSuccess = False) Then
        ConsoleWrite($oOauth2.LastErrorText & @CRLF)
        Exit
    EndIf

    ConsoleWrite("New access token: " & $oOauth2.AccessToken & @CRLF)

    ; Update the JSON with the new tokens.
    $oJsonToken.UpdateString("access_token",$oOauth2.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.
    $oSbJson = ObjCreate("Chilkat.StringBuilder")
    $oJsonToken.EmitCompact = False
    $oJsonToken.EmitSb($oSbJson)
    $oSbJson.WriteFile("qa_data/tokens/qb-access-token.json","utf-8",False)

    ConsoleWrite("OAuth2 token refreshed!" & @CRLF)
    ConsoleWrite("New Access Token = " & $oOauth2.AccessToken & @CRLF)

    $oSbAuth.Clear 
    $oSbAuth.Append("Bearer ")
    $oSbAuth.Append($oOauth2.AccessToken)
    $oRest.Authorization = $oSbAuth.GetAsString()

    ; Now retry the request with the refreshed access token...
    $sResponseBody = $oRest.FullRequestNoBody("GET","/v3/company/123146096291789/employee/58?minorversion=45")
    If ($oRest.LastMethodSuccess = False) Then
        ConsoleWrite($oRest.LastErrorText & @CRLF)
        Exit
    EndIf

EndIf

; We should expect a 200 response if successful.
If ($oRest.ResponseStatusCode <> 200) Then
    ConsoleWrite("Request Header: " & @CRLF)
    ConsoleWrite($oRest.LastRequestHeader & @CRLF)
    ConsoleWrite("----" & @CRLF)
    ConsoleWrite("Response StatusCode = " & $oRest.ResponseStatusCode & @CRLF)
    ConsoleWrite("Response StatusLine: " & $oRest.ResponseStatusText & @CRLF)
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oRest.ResponseHeader & @CRLF)
    ConsoleWrite($sResponseBody & @CRLF)
    Exit
EndIf

; Load the JSON response into a JSON object for parsing.
; A sample JSON response is shown below.
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.Load($sResponseBody)

; These will be used for parsing date/time strings..
$oDtime = ObjCreate("Chilkat.CkDateTime")
Local $bLocalTime = True

; Show the JSON.   
$oJson.EmitCompact = False
ConsoleWrite($oJson.Emit() & @CRLF)

; Get some information from the JSON..
ConsoleWrite("Name: " & $oJson.StringOf("Employee.DisplayName") & @CRLF)
ConsoleWrite("Id: " & $oJson.StringOf("Employee.Id") & @CRLF)
ConsoleWrite("City: " & $oJson.StringOf("Employee.PrimaryAddr.City") & @CRLF)
ConsoleWrite("PostalCode: " & $oJson.StringOf("Employee.PrimaryAddr.PostalCode") & @CRLF)

; Load the CreateTime into a CkDateTime...
$oDtime.SetFromTimestamp($oJson.StringOf("Employee.MetaData.CreateTime"))
$oDt = ObjCreate("Chilkat.DtObj")
$oDtime.ToDtObj $bLocalTime,$oDt

ConsoleWrite($oDt.Month & "/" & $oDt.Day & "/" & $oDt.Year & "  " & $oDt.Hour & ":" & $oDt.Minute & @CRLF)

ConsoleWrite("Success." & @CRLF)

; 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"
;