Xbase++ Requires Chilkat v10.1.2+

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. Xbase++

LOCAL nSuccess
LOCAL oOauth2
LOCAL cUrl
LOCAL nNumMsWaited
LOCAL oSbJson
LOCAL cRealmId

nSuccess := 0

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

oOauth2 := CreateObject("Chilkat.OAuth2")

//  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

oOauth2:AppCallbackUrl := "https://yourwebserver.com/OAuth2.php"
oOauth2:ListenPort := 3017

oOauth2:AuthorizationEndpoint := "https://appcenter.intuit.com/connect/oauth2"
oOauth2:TokenEndpoint := "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"

//  Replace these with actual values.
oOauth2:ClientId := "QUICKBOOKS-CLIENT-ID"
oOauth2:ClientSecret := "QUICKBOOKS-CLIENT-SECRET"
oOauth2:UseBasicAuth := 1
oOauth2:CodeChallenge := 0

//  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
oOauth2:Scope := "com.intuit.quickbooks.accounting"

//  Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
cUrl := oOauth2:StartAuth()
IF (oOauth2:LastMethodSuccess == 0)
    ? oOauth2:LastErrorText
    oOauth2:destroy()
    RETURN
ENDIF

? "url = " + cUrl

//  Launch the default browser on the system and navigate to the url.
//  The LaunchBrowser method was added in Chilkat v10.1.2.
nSuccess := oOauth2:LaunchBrowser(cUrl)
IF (nSuccess == 0)
    ? oOauth2:LastErrorText
    oOauth2:destroy()
    RETURN
ENDIF

//  Wait for the user to approve or deny authorization in the browser.
nNumMsWaited := 0
DO WHILE (nNumMsWaited < 90000) .AND. (oOauth2:AuthFlowState < 3)
    oOauth2:SleepMs(100)
    nNumMsWaited := nNumMsWaited + 100
ENDDO

//  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 (oOauth2:AuthFlowState < 3)
    oOauth2:Cancel()
    ? "No response from the browser!"
    oOauth2:destroy()
    RETURN
ENDIF

//  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 (oOauth2:AuthFlowState == 5)
    ? "OAuth2 failed to complete."
    ? oOauth2:FailureInfo
    oOauth2:destroy()
    RETURN
ENDIF

IF (oOauth2:AuthFlowState == 4)
    ? "OAuth2 authorization was denied."
    ? oOauth2:AccessTokenResponse
    oOauth2:destroy()
    RETURN
ENDIF

IF (oOauth2:AuthFlowState != 3)
    ? "Unexpected AuthFlowState:" + Str(oOauth2:AuthFlowState)
    oOauth2:destroy()
    RETURN
ENDIF

//  Save the full JSON access token response to a file.
oSbJson := CreateObject("Chilkat.StringBuilder")
oSbJson:Append(oOauth2:AccessTokenResponse)
oSbJson:WriteFile("qa_data/tokens/qb-access-token.json", "utf-8", 0)

//  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"
//  }

? "OAuth2 authorization granted!"
? "Access Token = " + oOauth2:AccessToken

//  Get the realmId if needed...
//  See About the QuickBooks REST API Realm ID, also known as Company ID
cRealmId := oOauth2:GetRedirectRequestParam("realmId")
IF (oOauth2:LastMethodSuccess == 1)
    ? "realmId: " + cRealmId
ELSE
    ? "No realmId was provided."
ENDIF

oOauth2:destroy()
oSbJson:destroy()