(Tcl) Docusign OAuth2 Access Token

See more DocuSign Examples

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

Important: This example requires that you add a line of code (or a few lines of code) to launch a web browser that navigates to the URL returned by the StartAuth method. The Docusign account owner interactively authorizes the access just for the 1st time in getting the access token. Once the access token is obtained, it can be refreshed with no user interaction.

Also, you must define your app in the Docusign web portal under "My Apps / Integration Keys". You would need to add a Redirect URL such as "http://localhost:3017/". The port number in the Redirect URI must match the Chilkat OAuth2's ListenPort and the format of the URL should be exactly "http://localhost:3017/". Do not use "https://" because the redirect from the browser to your app (listening on a background thread in Chilkat) is a localhost-to-localhost connection.

For more information, see https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant

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 Redirect URI for your app defined in the Docusign developer portal.  
# The Redirect URI would look like "http://localhost:3017/" if the port number is 3017.
CkOAuth2_put_ListenPort $oauth2 3017

# For the developer sandbox environment, the authorization endpoint is https://account-d.docusign.com/oauth/auth
# For the production platform, the authorization endpoint is https://account.docusign.com/oauth/auth
CkOAuth2_put_AuthorizationEndpoint $oauth2 "https://account-d.docusign.com/oauth/auth"
CkOAuth2_put_TokenEndpoint $oauth2 "https://account-d.docusign.com/oauth/token"

# Replace these with actual values.
# The client ID is also known as the "integration key" in Docusign.
CkOAuth2_put_ClientId $oauth2 "MY_DOCUSIGN_CLIENT_ID"
# This is your secret key for the authorization code grant.
CkOAuth2_put_ClientSecret $oauth2 "MY_DOCUSIGN_CLIENT_SECRET"

CkOAuth2_put_Scope $oauth2 "signature"

# Begin the OAuth2 three-legged 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
}

# 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 30 seconds.
set numMsWaited 0
while {expr [$numMsWaited < 30000]  &&  [[CkOAuth2_get_AuthFlowState $oauth2] < 3]} {
    CkOAuth2_SleepMs $oauth2 100
    set numMsWaited [expr $numMsWaited + 100]
}

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

# 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 {[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": "eyJ0eXA....YQyig",
#   "token_type": "Bearer",
#   "refresh_token": "eyJ0eXA....auE3eHKg",
#   "expires_in": 28800
# }

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

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

delete_CkOAuth2 $oauth2
delete_CkJsonObject $json
delete_CkFileAccess $fac