(Lianja) Twinfield OAuth2 for Desktop App or Script

See more OAuth2 Examples

Demonstrates how to get a Twinfield OAuth2 access token from a desktop application or script.

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")

// This should be the port in the localhost callback URL for your app.  
// The callback URL would look like "http://localhost:3017/" if the port number is 3017.
loOauth2.ListenPort = 3017

loOauth2.AuthorizationEndpoint = "https://login.twinfield.com/auth/authentication/connect/authorize"
loOauth2.TokenEndpoint = "https://login.twinfield.com/auth/authentication/connect/token"

// Replace these with actual values.
loOauth2.ClientId = "CLIENT_ID"
loOauth2.ClientSecret = "CLIENT_SECRET"

loOauth2.Scope = "openid twf.user twf.organisation twf.organisationUser offline_access"

loOauth2.CodeChallenge = .T.
loOauth2.CodeChallengeMethod = "S256"

// Twinfield requires that the request to exchange the authorization code for a token must be a GET.
// (In most cases, OAuth2 is implemented where the exchange for token HTTP request is a POST.)
// Note: The exchange-for-token happens within Chilkat in a background thread.  After the user interactively 
// accepts or denies authorization, the browser receives the response and redirects to localhost:<port>,
// where Chilkat is waiting on a background thread to receive the redirect, process it, and then send the HTTP request
// to exchange the code for a token.  This happens internally while your code below is waiting for the authorization..)
loOauth2.UncommonOptions = "EXCHANGE_CODE_FOR_TOKEN_USING_GET"

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

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

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

? "OAuth2 authorization granted!"
? "Access Token = " + loOauth2.AccessToken

// Get the full JSON response:
loJson = createobject("CkJsonObject")
loJson.Load(loOauth2.AccessTokenResponse)
loJson.EmitCompact = .F.

// The JSON response looks like this:

? loJson.Emit()

// Save the JSON to a file for future requests.
loFac = createobject("CkFileAccess")
loFac.WriteEntireTextFile("qa_data/tokens/twinfield.json",loJson.Emit(),"utf-8",.F.)


release loOauth2
release loJson
release loFac