(Tcl) Vonage UC Extend OAuth2

Get an OAuth2 access token for a desktop application for Vonage.

Note: This example requires Chilkat v10.1.2 or greater.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

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:3800/" if the port number is 3017.
CkOAuth2_put_ListenPort $oauth2 3800

CkOAuth2_put_AuthorizationEndpoint $oauth2 "https://api.vonage.com/authorize"
CkOAuth2_put_TokenEndpoint $oauth2 "https://api.vonage.com/token"

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

CkOAuth2_put_Scope $oauth2 "openid"

# 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
puts [CkJsonObject_emit $json]

# The JSON response looks like this:

# {
#   "access_token": "XXXXXXXX-XXX-XXXX-XXXX-XXXXXXXXXXXX",
#   "refresh_token": "XXXXXXXX-XXX-XXXX-XXXX-XXXXXXXXXXXX",
#   "scope": "openid",
#   "id_token": "eyJ4NXQiOiJNem ... hA9tbDCiQRhdI4T0",
#   "token_type": "Bearer",
#   "expires_in": 3600
# }

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

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

delete_CkOAuth2 $oauth2
delete_CkJsonObject $json
delete_CkFileAccess $fac