(Objective-C) Adobe Sign OAuth2 Access Token

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

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoOAuth2.h>
#import <NSString.h>
#import <CkoStringBuilder.h>

// It requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

CkoOAuth2 *oauth2 = [[CkoOAuth2 alloc] init];
BOOL success;

// 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>/"
// It can be written in C#, PHP, or whatever desired.  It must include the query string in the redirection.
// For example, in PHP your script would look like this:

// <?php
//   header( 'Location: http://localhost:3017?' . $_SERVER['QUERY_STRING'] );
// ?>

oauth2.AppCallbackUrl = @"https://yourwebserver.com/OAuth2.php";
oauth2.ListenPort = [NSNumber numberWithInt: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";
oauth2.ClientSecret = @"MY_CLIENT_SECRET";
oauth2.CodeChallenge = NO;

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

// Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
NSString *url = [oauth2 StartAuth];
if (oauth2.LastMethodSuccess != YES) {
    NSLog(@"%@",oauth2.LastErrorText);
    return;
}

NSLog(@"%@%@",@"url = ",url);

// 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 Adobe Sign 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 60 seconds.
int numMsWaited = 0;
while ((numMsWaited < 60000) && ([oauth2.AuthFlowState intValue] < 3)) {
    [oauth2 SleepMs: [NSNumber numberWithInt: 100]];
    numMsWaited = numMsWaited + 100;
}

// If there was no response from the browser within 60 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 ([oauth2.AuthFlowState intValue] < 3) {
    [oauth2 Cancel];
    NSLog(@"%@",@"No response from the browser!");
    return;
}

// 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 ([oauth2.AuthFlowState intValue] == 5) {
    NSLog(@"%@",@"OAuth2 failed to complete.");
    NSLog(@"%@",oauth2.FailureInfo);
    return;
}

if ([oauth2.AuthFlowState intValue] == 4) {
    NSLog(@"%@",@"OAuth2 authorization was denied.");
    NSLog(@"%@",oauth2.AccessTokenResponse);
    return;
}

if ([oauth2.AuthFlowState intValue] != 3) {
    NSLog(@"%@%d",@"Unexpected AuthFlowState:",[oauth2.AuthFlowState intValue]);
    return;
}

// Save the full JSON access token response to a file.
CkoStringBuilder *sbJson = [[CkoStringBuilder alloc] init];
[sbJson Append: oauth2.AccessTokenResponse];
[sbJson WriteFile: @"qa_data/tokens/adobe-sign-access-token.json" charset: @"utf-8" emitBom: NO];

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

NSLog(@"%@",@"OAuth2 authorization granted!");
NSLog(@"%@%@",@"Access Token = ",oauth2.AccessToken);