Go

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

    success := 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"
    // }

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

    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 == false {
        fmt.Println(rest.LastErrorText())
        jsonToken.DisposeJsonObject()
        rest.DisposeRest()
        return
    }

    sbAuth := chilkat.NewStringBuilder()
    sbAuth.Append("Bearer ")
    sbAuth.Append(*jsonToken.StringOf("access_token"))
    rest.SetAuthorization(sbAuth.GetAsString())

    rest.AddHeader("Accept","application/json")
    rest.SetAllowHeaderFolding(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() == false {
        fmt.Println(rest.LastErrorText())
        jsonToken.DisposeJsonObject()
        rest.DisposeRest()
        sbAuth.DisposeStringBuilder()
        return
    }

    // 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 {

        oauth2 := chilkat.NewOAuth2()

        oauth2.SetTokenEndpoint("https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer")

        // Replace these with actual values.
        oauth2.SetClientId("QUICKBOOKS-CLIENT-ID")
        oauth2.SetClientSecret("QUICKBOOKS-CLIENT-SECRET")

        // Get the "refresh_token"
        oauth2.SetRefreshToken(jsonToken.StringOf("refresh_token"))

        // Send the HTTP POST to refresh the access token..
        success = oauth2.RefreshAccessToken()
        if success == false {
            fmt.Println(oauth2.LastErrorText())
            jsonToken.DisposeJsonObject()
            rest.DisposeRest()
            sbAuth.DisposeStringBuilder()
            oauth2.DisposeOAuth2()
            return
        }

        fmt.Println("New access token: ", oauth2.AccessToken())

        // Update the JSON with the new tokens.
        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.
        sbJson := chilkat.NewStringBuilder()
        jsonToken.SetEmitCompact(false)
        jsonToken.EmitSb(sbJson)
        sbJson.WriteFile("qa_data/tokens/qb-access-token.json","utf-8",false)

        fmt.Println("OAuth2 token refreshed!")
        fmt.Println("New Access Token = ", oauth2.AccessToken())

        sbAuth.Clear()
        sbAuth.Append("Bearer ")
        sbAuth.Append(oauth2.AccessToken())
        rest.SetAuthorization(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() == false {
            fmt.Println(rest.LastErrorText())
            jsonToken.DisposeJsonObject()
            rest.DisposeRest()
            sbAuth.DisposeStringBuilder()
            oauth2.DisposeOAuth2()
            sbJson.DisposeStringBuilder()
            return
        }

    }

    // We should expect a 200 response if successful.
    if rest.ResponseStatusCode() != 200 {
        fmt.Println("Request Header: ")
        fmt.Println(rest.LastRequestHeader())
        fmt.Println("----")
        fmt.Println("Response StatusCode = ", rest.ResponseStatusCode())
        fmt.Println("Response StatusLine: ", rest.ResponseStatusText())
        fmt.Println("Response Header:")
        fmt.Println(rest.ResponseHeader())
        fmt.Println(*responseBody)
        jsonToken.DisposeJsonObject()
        rest.DisposeRest()
        sbAuth.DisposeStringBuilder()
        oauth2.DisposeOAuth2()
        sbJson.DisposeStringBuilder()
        return
    }

    // Load the JSON response into a JSON object for parsing.
    // A sample JSON response is shown below.
    json := chilkat.NewJsonObject()
    json.Load(*responseBody)

    // These will be used for parsing date/time strings..
    dtime := chilkat.NewCkDateTime()
    bLocalTime := true

    // Show the JSON.   
    json.SetEmitCompact(false)
    fmt.Println(*json.Emit())

    // Get some information from the JSON..
    fmt.Println("Name: ", *json.StringOf("Employee.DisplayName"))
    fmt.Println("Id: ", *json.StringOf("Employee.Id"))
    fmt.Println("City: ", *json.StringOf("Employee.PrimaryAddr.City"))
    fmt.Println("PostalCode: ", *json.StringOf("Employee.PrimaryAddr.PostalCode"))

    // Load the CreateTime into a CkDateTime...
    dtime.SetFromTimestamp(*json.StringOf("Employee.MetaData.CreateTime"))
    dt := chilkat.NewDtObj()
    dtime.ToDtObj(bLocalTime,dt)

    fmt.Println(dt.Month(), "/", dt.Day(), "/", dt.Year(), "  ", dt.Hour(), ":", dt.Minute())

    fmt.Println("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"
    // 

    jsonToken.DisposeJsonObject()
    rest.DisposeRest()
    sbAuth.DisposeStringBuilder()
    oauth2.DisposeOAuth2()
    sbJson.DisposeStringBuilder()
    json.DisposeJsonObject()
    dtime.DisposeCkDateTime()
    dt.DisposeDtObj()