(Lianja) Get a Xero OAuth2 Access Token

Gets a Xero OAuth2 access token.

Chilkat Lianja Extension Download Chilkat Lianja Extension

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loOauth2 = createobject("CkOAuth2")

// For Xero OAuth2, set the listen port equal to the port used
// in the Authorized Redirect URL for the Client ID.
// For example, in this case the Authorized Redirect URL would be http://localhost:55568/
// Your app should choose a port not likely not used by any other application.
// See Xero OAuth2 for Desktop Apps for more information.
loOauth2.ListenPort = 55568

loOauth2.AuthorizationEndpoint = "https://login.xero.com/identity/connect/authorize"
loOauth2.TokenEndpoint = "https://identity.xero.com/connect/token"

// Replace these with actual values.
loOauth2.ClientId = "XERO_APP_OAUTH2_CLIENT_ID"
loOauth2.ClientSecret = "XERO_APP_OAUTH2_CLIENT_SECRET"
loOauth2.UseBasicAuth = .T.

// See https://developer.xero.com/documentation/oauth2/scopes for a complete list of scopes.
// You will need to change the scopes depending on what access is needed..
loOauth2.Scope = "openid profile email accounting.transactions accounting.attachments accounting.settings payroll.employees offline_access"

// Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
lcUrl = loOauth2.StartAuth()
if (loOauth2.LastMethodSuccess <> .T.) then
    ? loOauth2.LastErrorText
    release loOauth2
    return
endif

? "URL: " + lcUrl

// At this point, your application should load the URL in a browser.
// For example, 
// in C#: System.Diagnostics.Process.Start(url);
// in Java: Desktop.getDesktop().browse(new URI(url));
// in VBScript: Set wsh=WScript.CreateObject("WScript.Shell")
//              wsh.Run url
// in Xojo: ShowURL(url)  (see http://docs.xojo.com/index.php/ShowURL)
// in Dataflex: Runprogram Background "c:\Program Files\Internet Explorer\iexplore.exe" sUrl        
// in dBASE: run(false, 'rundll32 url.dll,FileProtocolHandler "' + lcUrl + '"')
// The Google account owner would interactively accept or deny the authorization request.

// Add the code to load the url in a web browser here...
// Add the code to load the url in a web browser here...
// Add the code to load the url in a web browser here...
// System.Diagnostics.Process.Start(url);

// Now wait for the authorization.
// We'll wait for a max of 60 seconds.
lnNumMsWaited = 0
do while (lnNumMsWaited < 60000) and (loOauth2.AuthFlowState < 3)
    loOauth2.SleepMs(100)
    lnNumMsWaited = lnNumMsWaited + 100
enddo

// If there was no response from the browser within 30 seconds, then 
// the AuthFlowState will be equal to 1 or 2.
// 1: Waiting for Redirect. The OAuth2 background thread is waiting to receive the redirect HTTP request from the browser.
// 2: Waiting for Final Response. The OAuth2 background thread is waiting for the final access token response.
// In that case, cancel the background task started in the call to StartAuth.
if (loOauth2.AuthFlowState < 3) then
    loOauth2.Cancel()
    ? "No response from the browser!"
    release loOauth2
    return
endif

// Check the AuthFlowState to see if authorization was granted, denied, or if some error occurred
// The possible AuthFlowState values are:
// 3: Completed with Success. The OAuth2 flow has completed, the background thread exited, and the successful JSON response is available in AccessTokenResponse property.
// 4: Completed with Access Denied. The OAuth2 flow has completed, the background thread exited, and the error JSON is available in AccessTokenResponse property.
// 5: Failed Prior to Completion. The OAuth2 flow failed to complete, the background thread exited, and the error information is available in the FailureInfo property.
if (loOauth2.AuthFlowState = 5) then
    ? "OAuth2 failed to complete."
    ? loOauth2.FailureInfo
    release loOauth2
    return
endif

if (loOauth2.AuthFlowState = 4) then
    ? "OAuth2 authorization was denied."
    ? loOauth2.AccessTokenResponse
    release loOauth2
    return
endif

if (loOauth2.AuthFlowState <> 3) then
    ? "Unexpected AuthFlowState:" + str(loOauth2.AuthFlowState)
    release loOauth2
    return
endif

// Save the full JSON access token response to a file.
loSbJson = createobject("CkStringBuilder")
loSbJson.Append(loOauth2.AccessTokenResponse)
loSbJson.WriteFile("qa_data/tokens/xero-access-token.json","utf-8",.F.)

// The saved JSON response looks like this:

// 	{
// 	 "access_token": "...",
// 	 "token_type": "Bearer",
// 	 "expires_in": 3600,
// 	 "refresh_token": "..."
// 	}
// 
? "OAuth2 authorization granted!"
? "Access Token = " + loOauth2.AccessToken


release loOauth2
release loSbJson