Unicode C
Unicode C
Quickbooks OAuth2 in a Desktop App
See more QuickBooks Examples
Demonstrates how to get a QuickBooks OAuth2 access token from a desktop application or script.Chilkat Unicode C Downloads
#include <C_CkOAuth2W.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
BOOL success;
HCkOAuth2W oauth2;
const wchar_t *url;
int numMsWaited;
HCkStringBuilderW sbJson;
const wchar_t *realmId;
success = FALSE;
// To further clarify, see OAuth 2.0 Authorization Flow
// ------------------------------------------------------------------------------------------------
// IMPORTANT: You first need to define an App in the Quickbooks Developer Dashboard.
// See How to Create an App in QuickBooks Developer Dashboard
// ------------------------------------------------------------------------------------------------
// This example is for desktop applicatons (it is not for code that runs on a web server).
// You'll need to add a line (or a few lines of code) to popup a web browser that navigates to a URL.
// This is the way to initially obtain the OAuth2 access token. Afterwards it can be
// repeatedly refreshed without user interaction, as shown in this example: Refresh Quickbooks OAuth2 Access Token.
oauth2 = CkOAuth2W_Create();
// QuickBooks OAuth2 allows for an "http://localhost:<portNumber>/" callback URL for sandbox testing,
// but not for production.
// In production, your applicaton must use your own public web server as an intermediate
// to receive and forward the redirect to localhost.
// See Using Your Web Server as an Intermediary for OAuth2 Redirect to localhost
CkOAuth2W_putAppCallbackUrl(oauth2,L"https://yourwebserver.com/OAuth2.php");
CkOAuth2W_putListenPort(oauth2,3017);
CkOAuth2W_putAuthorizationEndpoint(oauth2,L"https://appcenter.intuit.com/connect/oauth2");
CkOAuth2W_putTokenEndpoint(oauth2,L"https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer");
// Replace these with actual values.
CkOAuth2W_putClientId(oauth2,L"QUICKBOOKS-CLIENT-ID");
CkOAuth2W_putClientSecret(oauth2,L"QUICKBOOKS-CLIENT-SECRET");
CkOAuth2W_putUseBasicAuth(oauth2,TRUE);
CkOAuth2W_putCodeChallenge(oauth2,FALSE);
// Indicate the desired access. Possible scopes that can appear in the list are:
// com.intuit.quickbooks.accounting: QuickBooks Online API
// com.intuit.quickbooks.payment: QuickBooks Payments API
// openid: OpenID Connect processing
// profile: user's given and family names
// email: user's email address
// phone: user's phone number
// address: user's physical address
CkOAuth2W_putScope(oauth2,L"com.intuit.quickbooks.accounting");
// Begin the OAuth2 Authorization code flow. This returns a URL that should be loaded in a browser.
url = CkOAuth2W_startAuth(oauth2);
if (CkOAuth2W_getLastMethodSuccess(oauth2) == FALSE) {
wprintf(L"%s\n",CkOAuth2W_lastErrorText(oauth2));
CkOAuth2W_Dispose(oauth2);
return;
}
wprintf(L"url = %s\n",url);
// Launch the default browser on the system and navigate to the url.
// The LaunchBrowser method was added in Chilkat v10.1.2.
success = CkOAuth2W_LaunchBrowser(oauth2,url);
if (success == FALSE) {
wprintf(L"%s\n",CkOAuth2W_lastErrorText(oauth2));
CkOAuth2W_Dispose(oauth2);
return;
}
// Wait for the user to approve or deny authorization in the browser.
numMsWaited = 0;
while ((numMsWaited < 90000) && (CkOAuth2W_getAuthFlowState(oauth2) < 3)) {
CkOAuth2W_SleepMs(oauth2,100);
numMsWaited = numMsWaited + 100;
}
// If the browser does not respond within the specified time, AuthFlowState will be:
//
// 1: Waiting for Redirect – The OAuth2 background thread is waiting for the browser's redirect request.
// 2: Waiting for Final Response – The thread is awaiting the final access token response.
// In either case, cancel the background task initiated by StartAuth.
if (CkOAuth2W_getAuthFlowState(oauth2) < 3) {
CkOAuth2W_Cancel(oauth2);
wprintf(L"No response from the browser!\n");
CkOAuth2W_Dispose(oauth2);
return;
}
// Check AuthFlowState to determine if authorization was granted, denied, or failed:
//
// 3: Success – OAuth2 flow completed, the background thread exited, and the successful response is in AccessTokenResponse.
// 4: Access Denied – OAuth2 flow completed, the background thread exited, and the error response is in AccessTokenResponse.
// 5: Failure – OAuth2 flow failed before completion, the background thread exited, and error details are in FailureInfo.
if (CkOAuth2W_getAuthFlowState(oauth2) == 5) {
wprintf(L"OAuth2 failed to complete.\n");
wprintf(L"%s\n",CkOAuth2W_failureInfo(oauth2));
CkOAuth2W_Dispose(oauth2);
return;
}
if (CkOAuth2W_getAuthFlowState(oauth2) == 4) {
wprintf(L"OAuth2 authorization was denied.\n");
wprintf(L"%s\n",CkOAuth2W_accessTokenResponse(oauth2));
CkOAuth2W_Dispose(oauth2);
return;
}
if (CkOAuth2W_getAuthFlowState(oauth2) != 3) {
wprintf(L"Unexpected AuthFlowState:%d\n",CkOAuth2W_getAuthFlowState(oauth2));
CkOAuth2W_Dispose(oauth2);
return;
}
// Save the full JSON access token response to a file.
sbJson = CkStringBuilderW_Create();
CkStringBuilderW_Append(sbJson,CkOAuth2W_accessTokenResponse(oauth2));
CkStringBuilderW_WriteFile(sbJson,L"qa_data/tokens/qb-access-token.json",L"utf-8",FALSE);
// The full JSON received looks like this:
// {
// "expires_in": 3600,
// "x_refresh_token_expires_in": 8726400,
// "refresh_token": "L011546037639r ... 3vR2DrbOmg0Sdagw",
// "access_token": "eyJlbmMiOiJBMTI4Q0 ... oETJEMbeggg",
// "token_type": "bearer"
// }
wprintf(L"OAuth2 authorization granted!\n");
wprintf(L"Access Token = %s\n",CkOAuth2W_accessToken(oauth2));
// Get the realmId if needed...
// See About the QuickBooks REST API Realm ID, also known as Company ID
realmId = CkOAuth2W_getRedirectRequestParam(oauth2,L"realmId");
if (CkOAuth2W_getLastMethodSuccess(oauth2) == TRUE) {
wprintf(L"realmId: %s\n",realmId);
}
else {
wprintf(L"No realmId was provided.\n");
}
CkOAuth2W_Dispose(oauth2);
CkStringBuilderW_Dispose(sbJson);
}