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

import 'package:chilkat/chilkat.dart';

void main() {
  // 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"
  // }

  final jsonToken = CkJsonObject();
  jsonToken.loadFile('qa_data/tokens/qb-access-token.json');

  final rest = 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.
  final bAutoReconnect = true;
  try {
    rest.connect('sandbox-quickbooks.api.intuit.com', 443, true, bAutoReconnect);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final sbAuth = CkStringBuilder();
  sbAuth.append('Bearer ');
  sbAuth.append(jsonToken.stringOf('access_token'));
  rest.authorization = sbAuth.getAsString();

  rest.addHeader('Accept', 'application/json');
  rest.allowHeaderFolding = false;

  // The company ID is 123146096291789
  // The employee ID is 58
  String responseBody;
  try {
    responseBody = rest.fullRequestNoBody('GET', '/v3/company/123146096291789/employee/58?minorversion=45');
  } on ChilkatException catch (e) {
    print(e.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.responseStatusCode == 401) {

    final oauth2 = CkOAuth2();

    oauth2.tokenEndpoint = 'https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer';

    // Replace these with actual values.
    oauth2.clientId = 'QUICKBOOKS-CLIENT-ID';
    oauth2.clientSecret = 'QUICKBOOKS-CLIENT-SECRET';

    // Get the "refresh_token"
    oauth2.refreshToken = jsonToken.stringOf('refresh_token');

    // Send the HTTP POST to refresh the access token..
    try {
      oauth2.refreshAccessToken();
    } on ChilkatException catch (e) {
      print(e.lastErrorText);
      return;
    }

    print('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.
    final sbJson = CkStringBuilder();
    jsonToken.emitCompact = false;
    jsonToken.emitSb(sbJson);
    sbJson.writeFile('qa_data/tokens/qb-access-token.json', 'utf-8', false);

    print('OAuth2 token refreshed!');
    print('New Access Token = ${oauth2.accessToken}');

    sbAuth.clear();
    sbAuth.append('Bearer ');
    sbAuth.append(oauth2.accessToken);
    rest.authorization = sbAuth.getAsString();

    // Now retry the request with the refreshed access token...
    try {
      responseBody = rest.fullRequestNoBody('GET', '/v3/company/123146096291789/employee/58?minorversion=45');
    } on ChilkatException catch (e) {
      print(e.lastErrorText);
      return;
    }
  }

  // We should expect a 200 response if successful.
  if (rest.responseStatusCode != 200) {
    print('Request Header: ');
    print(rest.lastRequestHeader);
    print('----');
    print('Response StatusCode = ${rest.responseStatusCode}');
    print('Response StatusLine: ${rest.responseStatusText}');
    print('Response Header:');
    print(rest.responseHeader);
    print(responseBody);
    return;
  }

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

  // These will be used for parsing date/time strings..
  final dtime = CkDateTime();
  final bLocalTime = true;

  // Show the JSON.   
  json.emitCompact = false;
  print(json.emit());

  // Get some information from the JSON..
  print('Name: ${json.stringOf('Employee.DisplayName')}');
  print('Id: ${json.stringOf('Employee.Id')}');
  print('City: ${json.stringOf('Employee.PrimaryAddr.City')}');
  print('PostalCode: ${json.stringOf('Employee.PrimaryAddr.PostalCode')}');

  // Load the CreateTime into a CkDateTime...
  dtime.setFromTimestamp(json.stringOf('Employee.MetaData.CreateTime'));
  final dt = CkDtObj();
  dtime.toDtObj(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"
  // }
}