Lua Requires Chilkat v11.0.0+

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

local chilkat = require("chilkat")

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

local jsonToken = chilkat.JsonObject.new()
local success = jsonToken:load_file("qa_data/tokens/qb-access-token.json")

local rest = chilkat.Rest.new()

-- 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
success = rest:connect("sandbox-quickbooks.api.intuit.com", 443, true, bAutoReconnect)
if not success then
    print(rest.last_error_text)
    return
end

local sbAuth = chilkat.StringBuilder.new()
sbAuth:append("Bearer ")
sbAuth:append(jsonToken:string_of("access_token"))
rest.authorization = sbAuth:get_as_string()

rest:add_header("Accept", "application/json")
rest.allow_header_folding = false

-- The company ID is 123146096291789
-- The employee ID is 58
local responseBody = rest:full_request_no_body("GET", "/v3/company/123146096291789/employee/58?minorversion=45")
if not rest.last_method_success then
    print(rest.last_error_text)
    return
end

-- 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.response_status_code == 401 then
    local oauth2 = chilkat.OAuth2.new()

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

    -- Replace these with actual values.
    oauth2.client_id = "QUICKBOOKS-CLIENT-ID"
    oauth2.client_secret = "QUICKBOOKS-CLIENT-SECRET"

    -- Get the "refresh_token"
    oauth2.refresh_token = jsonToken:string_of("refresh_token")

    -- Send the HTTP POST to refresh the access token..
    success = oauth2:refresh_access_token()
    if not success then
        print(oauth2.last_error_text)
        return
    end

    print("New access token: " .. oauth2.access_token)

    -- Update the JSON with the new tokens.
    jsonToken:update_string("access_token", oauth2.access_token)

    -- 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.
    local sbJson = chilkat.StringBuilder.new()
    jsonToken.emit_compact = false
    jsonToken:emit_sb(sbJson)
    sbJson:write_file("qa_data/tokens/qb-access-token.json", "utf-8", false)

    print("OAuth2 token refreshed!")
    print("New Access Token = " .. oauth2.access_token)

    sbAuth:clear()
    sbAuth:append("Bearer ")
    sbAuth:append(oauth2.access_token)
    rest.authorization = sbAuth:get_as_string()

    -- Now retry the request with the refreshed access token...
    responseBody = rest:full_request_no_body("GET", "/v3/company/123146096291789/employee/58?minorversion=45")
    if not rest.last_method_success then
        print(rest.last_error_text)
        return
    end
end

-- We should expect a 200 response if successful.
if rest.response_status_code ~= 200 then
    print("Request Header: ")
    print(rest.last_request_header)
    print("----")
    print("Response StatusCode = " .. rest.response_status_code)
    print("Response StatusLine: " .. rest.response_status_text)
    print("Response Header:")
    print(rest.response_header)
    print(responseBody)
    return
end

-- Load the JSON response into a JSON object for parsing.
-- A sample JSON response is shown below.
local json = chilkat.JsonObject.new()
json:load(responseBody)

-- These will be used for parsing date/time strings..
local dtime = chilkat.DateTime.new()
local bLocalTime = true

-- Show the JSON.
json.emit_compact = false
print(json:emit())

-- Get some information from the JSON..
print("Name: " .. json:string_of("Employee.DisplayName"))
print("Id: " .. json:string_of("Employee.Id"))
print("City: " .. json:string_of("Employee.PrimaryAddr.City"))
print("PostalCode: " .. json:string_of("Employee.PrimaryAddr.PostalCode"))

-- Load the CreateTime into a CkDateTime...
dtime:set_from_timestamp(json:string_of("Employee.MetaData.CreateTime"))
local dt = chilkat.DtObj.new()
dtime:to_dt_obj(bLocalTime, dt)

print(dt.month .. "/" .. dt.day .. "/" .. dt.year .. "  " .. dt.hour .. ":" .. dt.minute)

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