Delphi DLL 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. Delphi DLL

var
success: Boolean;
oauth2: HCkOAuth2;
url: PWideChar;
numMsWaited: Integer;
sbJson: HCkStringBuilder;

begin
success := False;

//  To further clarify, see OAuth 2.0 Authorization Flow

oauth2 := CkOAuth2_Create();

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

CkOAuth2_putAppCallbackUrl(oauth2,'https://yourwebserver.com/OAuth2.php');
CkOAuth2_putListenPort(oauth2,3017);

CkOAuth2_putAuthorizationEndpoint(oauth2,'https://secure.na2.echosign.com/public/oauth');
CkOAuth2_putTokenEndpoint(oauth2,'https://api.na2.echosign.com/oauth/token');

//  Replace these with actual values.
CkOAuth2_putClientId(oauth2,'MY_CLIENT_ID');

//  This is for Require Proof Key for Code Exchange (PKCE)
//  See OAuth2 PKCE Explained
CkOAuth2_putCodeChallenge(oauth2,True);
CkOAuth2_putCodeChallengeMethod(oauth2,'S256');

//  Indicate the desired access by listing scopes.
CkOAuth2_putScope(oauth2,'user_read agreement_read workflow_read');

//  Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
url := CkOAuth2__startAuth(oauth2);
if (CkOAuth2_getLastMethodSuccess(oauth2) <> True) then
  begin
    Memo1.Lines.Add(CkOAuth2__lastErrorText(oauth2));
    Exit;
  end;

Memo1.Lines.Add('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 := CkOAuth2_LaunchBrowser(oauth2,url);
if (success = False) then
  begin
    Memo1.Lines.Add(CkOAuth2__lastErrorText(oauth2));
    Exit;
  end;

//  Wait for the user to approve or deny authorization in the browser.
numMsWaited := 0;
while (numMsWaited < 90000) and (CkOAuth2_getAuthFlowState(oauth2) < 3) do
  begin
    CkOAuth2_SleepMs(oauth2,100);
    numMsWaited := numMsWaited + 100;
  end;

//  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_getAuthFlowState(oauth2) < 3) then
  begin
    CkOAuth2_Cancel(oauth2);
    Memo1.Lines.Add('No response from the browser!');
    Exit;
  end;

//  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_getAuthFlowState(oauth2) = 5) then
  begin
    Memo1.Lines.Add('OAuth2 failed to complete.');
    Memo1.Lines.Add(CkOAuth2__failureInfo(oauth2));
    Exit;
  end;

if (CkOAuth2_getAuthFlowState(oauth2) = 4) then
  begin
    Memo1.Lines.Add('OAuth2 authorization was denied.');
    Memo1.Lines.Add(CkOAuth2__accessTokenResponse(oauth2));
    Exit;
  end;

if (CkOAuth2_getAuthFlowState(oauth2) <> 3) then
  begin
    Memo1.Lines.Add('Unexpected AuthFlowState:' + IntToStr(CkOAuth2_getAuthFlowState(oauth2)));
    Exit;
  end;

//  Save the full JSON access token response to a file.
sbJson := CkStringBuilder_Create();
CkStringBuilder_Append(sbJson,CkOAuth2__accessTokenResponse(oauth2));
CkStringBuilder_WriteFile(sbJson,'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
//  }

Memo1.Lines.Add('OAuth2 authorization granted!');
Memo1.Lines.Add('Access Token = ' + CkOAuth2__accessToken(oauth2));

CkOAuth2_Dispose(oauth2);
CkStringBuilder_Dispose(sbJson);