AutoIt

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

Local $bSuccess = False

; For more information about the OAuth2, see OAuth 2.0 Authorization Flow

$oOauth2 = ObjCreate("Chilkat.OAuth2")

; 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.
$oOauth2.ListenPort = 3017

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

; Replace these with actual values.
$oOauth2.ClientId = "CLIENT_ID"
$oOauth2.ClientSecret = "CLIENT_SECRET"

$oOauth2.Scope = "openid twf.user twf.organisation twf.organisationUser offline_access"

$oOauth2.CodeChallenge = True
$oOauth2.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..)
$oOauth2.UncommonOptions = "EXCHANGE_CODE_FOR_TOKEN_USING_GET"

; Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
Local $sUrl = $oOauth2.StartAuth()
If ($oOauth2.LastMethodSuccess <> True) 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

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

; Get the full JSON response:
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.Load($oOauth2.AccessTokenResponse)
$oJson.EmitCompact = False

; The JSON response looks like this:

ConsoleWrite($oJson.Emit() & @CRLF)

; Save the JSON to a file for future requests.
$oFac = ObjCreate("Chilkat.FileAccess")
$oFac.WriteEntireTextFile("qa_data/tokens/twinfield.json",$oJson.Emit(),"utf-8",False)