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

llSuccess = .F.

//  To further clarify, see OAuth 2.0 Authorization Flow

loOauth2 = createobject("CkOAuth2")

//  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

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

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

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

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

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

//  Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
lcUrl = loOauth2.StartAuth()
if (loOauth2.LastMethodSuccess <> .T.) then
    ? loOauth2.LastErrorText
    release loOauth2
    return
endif

? "url = " + lcUrl

//  Launch the default browser on the system and navigate to the url.
//  The LaunchBrowser method was added in Chilkat v10.1.2.
llSuccess = loOauth2.LaunchBrowser(lcUrl)
if (llSuccess = .F.) then
    ? loOauth2.LastErrorText
    release loOauth2
    return
endif

//  Wait for the user to approve or deny authorization in the browser.
lnNumMsWaited = 0
do while (lnNumMsWaited < 90000) and (loOauth2.AuthFlowState < 3)
    loOauth2.SleepMs(100)
    lnNumMsWaited = lnNumMsWaited + 100
enddo

//  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 (loOauth2.AuthFlowState < 3) then
    loOauth2.Cancel()
    ? "No response from the browser!"
    release loOauth2
    return
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 (loOauth2.AuthFlowState = 5) then
    ? "OAuth2 failed to complete."
    ? loOauth2.FailureInfo
    release loOauth2
    return
endif

if (loOauth2.AuthFlowState = 4) then
    ? "OAuth2 authorization was denied."
    ? loOauth2.AccessTokenResponse
    release loOauth2
    return
endif

if (loOauth2.AuthFlowState <> 3) then
    ? "Unexpected AuthFlowState:" + str(loOauth2.AuthFlowState)
    release loOauth2
    return
endif

//  Save the full JSON access token response to a file.
loSbJson = createobject("CkStringBuilder")
loSbJson.Append(loOauth2.AccessTokenResponse)
loSbJson.WriteFile("qa_data/tokens/adobe-sign-access-token.json","utf-8",.F.)

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

? "OAuth2 authorization granted!"
? "Access Token = " + loOauth2.AccessToken


release loOauth2
release loSbJson