(Java) 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 Java Downloads Java Libs for Windows, MacOS, Linux, Alpine Linux, Solaris Java Libs for Android

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // 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"
    // }

    CkJsonObject jsonToken = new CkJsonObject();
    boolean success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json");

    CkRest rest = new CkRest();

    // 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.
    boolean bAutoReconnect = true;
    success = rest.Connect("sandbox-quickbooks.api.intuit.com",443,true,bAutoReconnect);
    if (success != true) {
        System.out.println(rest.lastErrorText());
        return;
        }

    CkStringBuilder sbAuth = new CkStringBuilder();
    sbAuth.Append("Bearer ");
    sbAuth.Append(jsonToken.stringOf("access_token"));
    rest.put_Authorization(sbAuth.getAsString());

    rest.AddHeader("Accept","application/json");
    rest.put_AllowHeaderFolding(false);

    // The company ID is 123146096291789
    // The employee ID is 58
    String responseBody = rest.fullRequestNoBody("GET","/v3/company/123146096291789/employee/58?minorversion=45");
    if (rest.get_LastMethodSuccess() != true) {
        System.out.println(rest.lastErrorText());
        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.get_ResponseStatusCode() == 401) {

        CkOAuth2 oauth2 = new CkOAuth2();

        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 != true) {
            System.out.println(oauth2.lastErrorText());
            return;
            }

        System.out.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.
        CkStringBuilder sbJson = new CkStringBuilder();
        jsonToken.put_EmitCompact(false);
        jsonToken.EmitSb(sbJson);
        sbJson.WriteFile("qa_data/tokens/qb-access-token.json","utf-8",false);

        System.out.println("OAuth2 token refreshed!");
        System.out.println("New Access Token = " + oauth2.accessToken());

        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() != true) {
            System.out.println(rest.lastErrorText());
            return;
            }

        }

    // We should expect a 200 response if successful.
    if (rest.get_ResponseStatusCode() != 200) {
        System.out.println("Request Header: ");
        System.out.println(rest.lastRequestHeader());
        System.out.println("----");
        System.out.println("Response StatusCode = " + rest.get_ResponseStatusCode());
        System.out.println("Response StatusLine: " + rest.responseStatusText());
        System.out.println("Response Header:");
        System.out.println(rest.responseHeader());
        System.out.println(responseBody);
        return;
        }

    // Load the JSON response into a JSON object for parsing.
    // A sample JSON response is shown below.
    CkJsonObject json = new CkJsonObject();
    json.Load(responseBody);

    // These will be used for parsing date/time strings..
    CkDateTime dtime = new CkDateTime();
    boolean bLocalTime = true;
    CkDtObj dt;

    // Show the JSON.   
    json.put_EmitCompact(false);
    System.out.println(json.emit());

    // Get some information from the JSON..
    System.out.println("Name: " + json.stringOf("Employee.DisplayName"));
    System.out.println("Id: " + json.stringOf("Employee.Id"));
    System.out.println("City: " + json.stringOf("Employee.PrimaryAddr.City"));
    System.out.println("PostalCode: " + json.stringOf("Employee.PrimaryAddr.PostalCode"));

    // Load the CreateTime into a CkDateTime...
    dtime.SetFromTimestamp(json.stringOf("Employee.MetaData.CreateTime"));
    dt = dtime.GetDtObj(bLocalTime);
    System.out.println(dt.get_Month() + "/" + dt.get_Day() + "/" + dt.get_Year() + "  " + dt.get_Hour() + ":"
         + dt.get_Minute());

    System.out.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"
    // 
  }
}