(Perl) 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 Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

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

$jsonToken = chilkat::CkJsonObject->new();
$success = $jsonToken->LoadFile("qa_data/tokens/qb-access-token.json");

$rest = chilkat::CkRest->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.
$bAutoReconnect = 1;
$success = $rest->Connect("sandbox-quickbooks.api.intuit.com",443,1,$bAutoReconnect);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

$sbAuth = chilkat::CkStringBuilder->new();
$sbAuth->Append("Bearer ");
$sbAuth->Append($jsonToken->stringOf("access_token"));
$rest->put_Authorization($sbAuth->getAsString());

$rest->AddHeader("Accept","application/json");
$rest->put_AllowHeaderFolding(0);

# The company ID is 123146096291789
# The employee ID is 58
$responseBody = $rest->fullRequestNoBody("GET","/v3/company/123146096291789/employee/58?minorversion=45");
if ($rest->get_LastMethodSuccess() != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

# 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->get_ResponseStatusCode() == 401) {

    $oauth2 = chilkat::CkOAuth2->new();

    $oauth2->put_TokenEndpoint("https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer");

    # Replace these with actual values.
    $oauth2->put_ClientId("QUICKBOOKS-CLIENT-ID");
    $oauth2->put_ClientSecret("QUICKBOOKS-CLIENT-SECRET");

    # Get the "refresh_token"
    $oauth2->put_RefreshToken($jsonToken->stringOf("refresh_token"));

    # Send the HTTP POST to refresh the access token..
    $success = $oauth2->RefreshAccessToken();
    if ($success != 1) {
        print $oauth2->lastErrorText() . "\r\n";
        exit;
    }

    print "New access token: " . $oauth2->accessToken() . "\r\n";

    # 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::CkStringBuilder->new();
    $jsonToken->put_EmitCompact(0);
    $jsonToken->EmitSb($sbJson);
    $sbJson->WriteFile("qa_data/tokens/qb-access-token.json","utf-8",0);

    print "OAuth2 token refreshed!" . "\r\n";
    print "New Access Token = " . $oauth2->accessToken() . "\r\n";

    $sbAuth->Clear();
    $sbAuth->Append("Bearer ");
    $sbAuth->Append($oauth2->accessToken());
    $rest->put_Authorization($sbAuth->getAsString());

    # Now retry the request with the refreshed access token...
    $responseBody = $rest->fullRequestNoBody("GET","/v3/company/123146096291789/employee/58?minorversion=45");
    if ($rest->get_LastMethodSuccess() != 1) {
        print $rest->lastErrorText() . "\r\n";
        exit;
    }

}

# We should expect a 200 response if successful.
if ($rest->get_ResponseStatusCode() != 200) {
    print "Request Header: " . "\r\n";
    print $rest->lastRequestHeader() . "\r\n";
    print "----" . "\r\n";
    print "Response StatusCode = " . $rest->get_ResponseStatusCode() . "\r\n";
    print "Response StatusLine: " . $rest->responseStatusText() . "\r\n";
    print "Response Header:" . "\r\n";
    print $rest->responseHeader() . "\r\n";
    print $responseBody . "\r\n";
    exit;
}

# Load the JSON response into a JSON object for parsing.
# A sample JSON response is shown below.
$json = chilkat::CkJsonObject->new();
$json->Load($responseBody);

# These will be used for parsing date/time strings..
$dtime = chilkat::CkDateTime->new();
$bLocalTime = 1;

# Show the JSON.   
$json->put_EmitCompact(0);
print $json->emit() . "\r\n";

# Get some information from the JSON..
print "Name: " . $json->stringOf("Employee.DisplayName") . "\r\n";
print "Id: " . $json->stringOf("Employee.Id") . "\r\n";
print "City: " . $json->stringOf("Employee.PrimaryAddr.City") . "\r\n";
print "PostalCode: " . $json->stringOf("Employee.PrimaryAddr.PostalCode") . "\r\n";

# Load the CreateTime into a CkDateTime...
$dtime->SetFromTimestamp($json->stringOf("Employee.MetaData.CreateTime"));
# dt is a DtObj
$dt = $dtime->GetDtObj($bLocalTime);
print $dt->get_Month() . "/" . $dt->get_Day() . "/" . $dt->get_Year() . "  " . $dt->get_Hour() . ":"
     . $dt->get_Minute() . "\r\n";

print "Success." . "\r\n";

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