AutoIt

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

Local $bSuccess = 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.

$oOauth2 = ObjCreate("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 = True
$oOauth2.CodeChallenge = 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
$oOauth2.Scope = "com.intuit.quickbooks.accounting"

; Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
Local $sUrl = $oOauth2.StartAuth()
If ($oOauth2.LastMethodSuccess = False) Then
    ConsoleWrite($oOauth2.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite("url = " & $sUrl & @CRLF)

; Launch the default browser on the system and navigate to the url.
; The LaunchBrowser method was added in Chilkat v10.1.2.
$bSuccess = $oOauth2.LaunchBrowser($sUrl)
If ($bSuccess = False) Then
    ConsoleWrite($oOauth2.LastErrorText & @CRLF)
    Exit
EndIf

; Wait for the user to approve or deny authorization in the browser.
Local $iNumMsWaited = 0
While ($iNumMsWaited < 90000) And ($oOauth2.AuthFlowState < 3)
    $oOauth2.SleepMs 100
    $iNumMsWaited = $iNumMsWaited + 100
Wend

; 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) Then
    $oOauth2.Cancel()
    ConsoleWrite("No response from the browser!" & @CRLF)
    Exit
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) Then
    ConsoleWrite("OAuth2 failed to complete." & @CRLF)
    ConsoleWrite($oOauth2.FailureInfo & @CRLF)
    Exit
EndIf

If ($oOauth2.AuthFlowState = 4) Then
    ConsoleWrite("OAuth2 authorization was denied." & @CRLF)
    ConsoleWrite($oOauth2.AccessTokenResponse & @CRLF)
    Exit
EndIf

If ($oOauth2.AuthFlowState <> 3) Then
    ConsoleWrite("Unexpected AuthFlowState:" & $oOauth2.AuthFlowState & @CRLF)
    Exit
EndIf

; Save the full JSON access token response to a file.
$oSbJson = ObjCreate("Chilkat.StringBuilder")
$oSbJson.Append($oOauth2.AccessTokenResponse)
$oSbJson.WriteFile("qa_data/tokens/qb-access-token.json","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"
; }

ConsoleWrite("OAuth2 authorization granted!" & @CRLF)
ConsoleWrite("Access Token = " & $oOauth2.AccessToken & @CRLF)

; Get the realmId if needed...
; See About the QuickBooks REST API Realm ID, also known as Company ID
Local $sRealmId = $oOauth2.GetRedirectRequestParam("realmId")
If ($oOauth2.LastMethodSuccess = True) Then
    ConsoleWrite("realmId: " & $sRealmId & @CRLF)
Else
    ConsoleWrite("No realmId was provided." & @CRLF)
EndIf