C
C
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.Chilkat C Downloads
#include <C_CkJsonObject.h>
#include <C_CkRest.h>
#include <C_CkStringBuilder.h>
#include <C_CkOAuth2.h>
#include <C_CkDateTime.h>
#include <C_CkDtObj.h>
void ChilkatSample(void)
{
BOOL success;
HCkJsonObject jsonToken;
HCkRest rest;
BOOL bAutoReconnect;
HCkStringBuilder sbAuth;
const char *responseBody;
HCkOAuth2 oauth2;
HCkStringBuilder sbJson;
HCkJsonObject json;
HCkDateTime dtime;
BOOL bLocalTime;
HCkDtObj dt;
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 = CkJsonObject_Create();
success = CkJsonObject_LoadFile(jsonToken,"qa_data/tokens/qb-access-token.json");
rest = CkRest_Create();
// 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 = CkRest_Connect(rest,"sandbox-quickbooks.api.intuit.com",443,TRUE,bAutoReconnect);
if (success == FALSE) {
printf("%s\n",CkRest_lastErrorText(rest));
CkJsonObject_Dispose(jsonToken);
CkRest_Dispose(rest);
return;
}
sbAuth = CkStringBuilder_Create();
CkStringBuilder_Append(sbAuth,"Bearer ");
CkStringBuilder_Append(sbAuth,CkJsonObject_stringOf(jsonToken,"access_token"));
CkRest_putAuthorization(rest,CkStringBuilder_getAsString(sbAuth));
CkRest_AddHeader(rest,"Accept","application/json");
CkRest_putAllowHeaderFolding(rest,FALSE);
// The company ID is 123146096291789
// The employee ID is 58
responseBody = CkRest_fullRequestNoBody(rest,"GET","/v3/company/123146096291789/employee/58?minorversion=45");
if (CkRest_getLastMethodSuccess(rest) == FALSE) {
printf("%s\n",CkRest_lastErrorText(rest));
CkJsonObject_Dispose(jsonToken);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbAuth);
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 (CkRest_getResponseStatusCode(rest) == 401) {
oauth2 = CkOAuth2_Create();
CkOAuth2_putTokenEndpoint(oauth2,"https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer");
// Replace these with actual values.
CkOAuth2_putClientId(oauth2,"QUICKBOOKS-CLIENT-ID");
CkOAuth2_putClientSecret(oauth2,"QUICKBOOKS-CLIENT-SECRET");
// Get the "refresh_token"
CkOAuth2_putRefreshToken(oauth2,CkJsonObject_stringOf(jsonToken,"refresh_token"));
// Send the HTTP POST to refresh the access token..
success = CkOAuth2_RefreshAccessToken(oauth2);
if (success == FALSE) {
printf("%s\n",CkOAuth2_lastErrorText(oauth2));
CkJsonObject_Dispose(jsonToken);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbAuth);
CkOAuth2_Dispose(oauth2);
return;
}
printf("New access token: %s\n",CkOAuth2_accessToken(oauth2));
// Update the JSON with the new tokens.
CkJsonObject_UpdateString(jsonToken,"access_token",CkOAuth2_accessToken(oauth2));
// 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 = CkStringBuilder_Create();
CkJsonObject_putEmitCompact(jsonToken,FALSE);
CkJsonObject_EmitSb(jsonToken,sbJson);
CkStringBuilder_WriteFile(sbJson,"qa_data/tokens/qb-access-token.json","utf-8",FALSE);
printf("OAuth2 token refreshed!\n");
printf("New Access Token = %s\n",CkOAuth2_accessToken(oauth2));
CkStringBuilder_Clear(sbAuth);
CkStringBuilder_Append(sbAuth,"Bearer ");
CkStringBuilder_Append(sbAuth,CkOAuth2_accessToken(oauth2));
CkRest_putAuthorization(rest,CkStringBuilder_getAsString(sbAuth));
// Now retry the request with the refreshed access token...
responseBody = CkRest_fullRequestNoBody(rest,"GET","/v3/company/123146096291789/employee/58?minorversion=45");
if (CkRest_getLastMethodSuccess(rest) == FALSE) {
printf("%s\n",CkRest_lastErrorText(rest));
CkJsonObject_Dispose(jsonToken);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbAuth);
CkOAuth2_Dispose(oauth2);
CkStringBuilder_Dispose(sbJson);
return;
}
}
// We should expect a 200 response if successful.
if (CkRest_getResponseStatusCode(rest) != 200) {
printf("Request Header: \n");
printf("%s\n",CkRest_lastRequestHeader(rest));
printf("----\n");
printf("Response StatusCode = %d\n",CkRest_getResponseStatusCode(rest));
printf("Response StatusLine: %s\n",CkRest_responseStatusText(rest));
printf("Response Header:\n");
printf("%s\n",CkRest_responseHeader(rest));
printf("%s\n",responseBody);
CkJsonObject_Dispose(jsonToken);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbAuth);
CkOAuth2_Dispose(oauth2);
CkStringBuilder_Dispose(sbJson);
return;
}
// Load the JSON response into a JSON object for parsing.
// A sample JSON response is shown below.
json = CkJsonObject_Create();
CkJsonObject_Load(json,responseBody);
// These will be used for parsing date/time strings..
dtime = CkDateTime_Create();
bLocalTime = TRUE;
// Show the JSON.
CkJsonObject_putEmitCompact(json,FALSE);
printf("%s\n",CkJsonObject_emit(json));
// Get some information from the JSON..
printf("Name: %s\n",CkJsonObject_stringOf(json,"Employee.DisplayName"));
printf("Id: %s\n",CkJsonObject_stringOf(json,"Employee.Id"));
printf("City: %s\n",CkJsonObject_stringOf(json,"Employee.PrimaryAddr.City"));
printf("PostalCode: %s\n",CkJsonObject_stringOf(json,"Employee.PrimaryAddr.PostalCode"));
// Load the CreateTime into a CkDateTime...
CkDateTime_SetFromTimestamp(dtime,CkJsonObject_stringOf(json,"Employee.MetaData.CreateTime"));
dt = CkDtObj_Create();
CkDateTime_ToDtObj(dtime,bLocalTime,dt);
printf("%d/%d/%d %d:%d\n",CkDtObj_getMonth(dt),CkDtObj_getDay(dt),CkDtObj_getYear(dt),CkDtObj_getHour(dt),CkDtObj_getMinute(dt));
printf("Success.\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"
//
CkJsonObject_Dispose(jsonToken);
CkRest_Dispose(rest);
CkStringBuilder_Dispose(sbAuth);
CkOAuth2_Dispose(oauth2);
CkStringBuilder_Dispose(sbJson);
CkJsonObject_Dispose(json);
CkDateTime_Dispose(dtime);
CkDtObj_Dispose(dt);
}