Tcl

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

load ./chilkat.dll

set success 0

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

set oauth2 [new_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.
CkOAuth2_put_ListenPort $oauth2 3017

CkOAuth2_put_AuthorizationEndpoint $oauth2 "https://login.twinfield.com/auth/authentication/connect/authorize"
CkOAuth2_put_TokenEndpoint $oauth2 "https://login.twinfield.com/auth/authentication/connect/token"

# Replace these with actual values.
CkOAuth2_put_ClientId $oauth2 "CLIENT_ID"
CkOAuth2_put_ClientSecret $oauth2 "CLIENT_SECRET"

CkOAuth2_put_Scope $oauth2 "openid twf.user twf.organisation twf.organisationUser offline_access"

CkOAuth2_put_CodeChallenge $oauth2 1
CkOAuth2_put_CodeChallengeMethod $oauth2 "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..)
CkOAuth2_put_UncommonOptions $oauth2 "EXCHANGE_CODE_FOR_TOKEN_USING_GET"

# Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
set url [CkOAuth2_startAuth $oauth2]
if {[CkOAuth2_get_LastMethodSuccess $oauth2] != 1} then {
    puts [CkOAuth2_lastErrorText $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

puts "url = $url"

# Launch the default browser on the system and navigate to the url.
# The LaunchBrowser method was added in Chilkat v10.1.2.
set success [CkOAuth2_LaunchBrowser $oauth2 $url]
if {$success == 0} then {
    puts [CkOAuth2_lastErrorText $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

# Wait for the user to approve or deny authorization in the browser.
set numMsWaited 0
while {expr [$numMsWaited < 90000]  &&  [[CkOAuth2_get_AuthFlowState $oauth2] < 3]} {
    CkOAuth2_SleepMs $oauth2 100
    set numMsWaited [expr $numMsWaited + 100]
}

# 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 {[CkOAuth2_get_AuthFlowState $oauth2] < 3} then {
    CkOAuth2_Cancel $oauth2
    puts "No response from the browser!"
    delete_CkOAuth2 $oauth2
    exit
}

# 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 {[CkOAuth2_get_AuthFlowState $oauth2] == 5} then {
    puts "OAuth2 failed to complete."
    puts [CkOAuth2_failureInfo $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

if {[CkOAuth2_get_AuthFlowState $oauth2] == 4} then {
    puts "OAuth2 authorization was denied."
    puts [CkOAuth2_accessTokenResponse $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

if {[CkOAuth2_get_AuthFlowState $oauth2] != 3} then {
    puts "Unexpected AuthFlowState:[CkOAuth2_get_AuthFlowState $oauth2]"
    delete_CkOAuth2 $oauth2
    exit
}

puts "OAuth2 authorization granted!"
puts "Access Token = [CkOAuth2_accessToken $oauth2]"

# Get the full JSON response:
set json [new_CkJsonObject]

CkJsonObject_Load $json [CkOAuth2_accessTokenResponse $oauth2]
CkJsonObject_put_EmitCompact $json 0

# The JSON response looks like this:

puts [CkJsonObject_emit $json]

# Save the JSON to a file for future requests.
set fac [new_CkFileAccess]

CkFileAccess_WriteEntireTextFile $fac "qa_data/tokens/twinfield.json" [CkJsonObject_emit $json] "utf-8" 0

delete_CkOAuth2 $oauth2
delete_CkJsonObject $json
delete_CkFileAccess $fac