PowerBuilder

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

integer li_rc
integer li_Success
oleobject loo_Oauth2
string ls_Url
integer li_NumMsWaited
oleobject loo_SbJson
string ls_RealmId

li_Success = 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.

loo_Oauth2 = create oleobject
li_rc = loo_Oauth2.ConnectToNewObject("Chilkat.OAuth2")
if li_rc < 0 then
    destroy loo_Oauth2
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

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

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

// Replace these with actual values.
loo_Oauth2.ClientId = "QUICKBOOKS-CLIENT-ID"
loo_Oauth2.ClientSecret = "QUICKBOOKS-CLIENT-SECRET"
loo_Oauth2.UseBasicAuth = 1
loo_Oauth2.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
loo_Oauth2.Scope = "com.intuit.quickbooks.accounting"

// Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
ls_Url = loo_Oauth2.StartAuth()
if loo_Oauth2.LastMethodSuccess = 0 then
    Write-Debug loo_Oauth2.LastErrorText
    destroy loo_Oauth2
    return
end if

Write-Debug "url = " + ls_Url

// Launch the default browser on the system and navigate to the url.
// The LaunchBrowser method was added in Chilkat v10.1.2.
li_Success = loo_Oauth2.LaunchBrowser(ls_Url)
if li_Success = 0 then
    Write-Debug loo_Oauth2.LastErrorText
    destroy loo_Oauth2
    return
end if

// Wait for the user to approve or deny authorization in the browser.
li_NumMsWaited = 0
do while (li_NumMsWaited < 90000) AND (loo_Oauth2.AuthFlowState < 3)
    loo_Oauth2.SleepMs(100)
    li_NumMsWaited = li_NumMsWaited + 100
loop

// 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 loo_Oauth2.AuthFlowState < 3 then
    loo_Oauth2.Cancel()
    Write-Debug "No response from the browser!"
    destroy loo_Oauth2
    return
end if

// 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 loo_Oauth2.AuthFlowState = 5 then
    Write-Debug "OAuth2 failed to complete."
    Write-Debug loo_Oauth2.FailureInfo
    destroy loo_Oauth2
    return
end if

if loo_Oauth2.AuthFlowState = 4 then
    Write-Debug "OAuth2 authorization was denied."
    Write-Debug loo_Oauth2.AccessTokenResponse
    destroy loo_Oauth2
    return
end if

if loo_Oauth2.AuthFlowState <> 3 then
    Write-Debug "Unexpected AuthFlowState:" + string(loo_Oauth2.AuthFlowState)
    destroy loo_Oauth2
    return
end if

// Save the full JSON access token response to a file.
loo_SbJson = create oleobject
li_rc = loo_SbJson.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbJson.Append(loo_Oauth2.AccessTokenResponse)
loo_SbJson.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"
// }

Write-Debug "OAuth2 authorization granted!"
Write-Debug "Access Token = " + loo_Oauth2.AccessToken

// Get the realmId if needed...
// See About the QuickBooks REST API Realm ID, also known as Company ID
ls_RealmId = loo_Oauth2.GetRedirectRequestParam("realmId")
if loo_Oauth2.LastMethodSuccess = 1 then
    Write-Debug "realmId: " + ls_RealmId
else
    Write-Debug "No realmId was provided."
end if



destroy loo_Oauth2
destroy loo_SbJson