Xojo Plugin Requires Chilkat v10.1.2+

Adobe Sign OAuth2 Access Token

See more OAuth2 Examples

Demonstrates how to get an Adobe Sign OAuth2 access token from a desktop application or script. Xojo Plugin

Dim success As Boolean
success = False

//  To further clarify, see OAuth 2.0 Authorization Flow

Dim oauth2 As New Chilkat.OAuth2

//  The Adobe Sign OAuth2 requires an "https" callback URL.  This means the "http://localhost:<portNumber>/" is not possible.
//  For a desktop app, you must provide a script on your web server to redirect to "http://localhost:<portNumber>/"

//  See Using Your Web Server as an Intermediary for OAuth2 Redirect to localhost

oauth2.AppCallbackUrl = "https://yourwebserver.com/OAuth2.php"
oauth2.ListenPort = 3017

oauth2.AuthorizationEndpoint = "https://secure.na2.echosign.com/public/oauth"
oauth2.TokenEndpoint = "https://api.na2.echosign.com/oauth/token"

//  Replace these with actual values.
oauth2.ClientId = "MY_CLIENT_ID"

//  This is for Require Proof Key for Code Exchange (PKCE)
//  See OAuth2 PKCE Explained
oauth2.CodeChallenge = True
oauth2.CodeChallengeMethod = "S256"

//  Indicate the desired access by listing scopes.
oauth2.Scope = "user_read agreement_read workflow_read"

//  Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
Dim url As String
url = oauth2.StartAuth()
If (oauth2.LastMethodSuccess <> True) Then
    System.DebugLog(oauth2.LastErrorText)
    Return
End If

System.DebugLog("url = " + url)

//  Launch the default browser on the system and navigate to the url.
//  The LaunchBrowser method was added in Chilkat v10.1.2.
success = oauth2.LaunchBrowser(url)
If (success = False) Then
    System.DebugLog(oauth2.LastErrorText)
    Return
End If

//  Wait for the user to approve or deny authorization in the browser.
Dim numMsWaited As Int32
numMsWaited = 0
While (numMsWaited < 90000) And (oauth2.AuthFlowState < 3)
    oauth2.SleepMs 100
    numMsWaited = numMsWaited + 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 (oauth2.AuthFlowState < 3) Then
    success = oauth2.Cancel()
    System.DebugLog("No response from the browser!")
    Return
End If

//  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 (oauth2.AuthFlowState = 5) Then
    System.DebugLog("OAuth2 failed to complete.")
    System.DebugLog(oauth2.FailureInfo)
    Return
End If

If (oauth2.AuthFlowState = 4) Then
    System.DebugLog("OAuth2 authorization was denied.")
    System.DebugLog(oauth2.AccessTokenResponse)
    Return
End If

If (oauth2.AuthFlowState <> 3) Then
    System.DebugLog("Unexpected AuthFlowState:" + Str(oauth2.AuthFlowState))
    Return
End If

//  Save the full JSON access token response to a file.
Dim sbJson As New Chilkat.StringBuilder
success = sbJson.Append(oauth2.AccessTokenResponse)
success = sbJson.WriteFile("qa_data/tokens/adobe-sign-access-token.json","utf-8",False)

//  The full JSON received looks like this:
//  {
//    "access_token": "3AAABL ... YCpUu",
//    "refresh_token": "3AAABL ... tpDs0*",
//    "token_type": "Bearer",
//    "expires_in": 3600
//  }

System.DebugLog("OAuth2 authorization granted!")
System.DebugLog("Access Token = " + oauth2.AccessToken)