Objective-C

Dropbox: OAuth2 Authorization to Obtain an Access Token

See more Dropbox Examples

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

This example runs the OAuth 2.0 authorization flow that lets the user sign in to Dropbox and authorize your app.

Objective-C

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

BOOL success = NO;

// For more information about the OAuth2, see OAuth 2.0 Authorization Flow

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

// The port should match the Authorized Redirect URL in your Dropbox app, 
// which would look like "http://localhost:3017/"
oauth2.ListenPort = [NSNumber numberWithInt:3017];

// IMPORTANT: One of the OAuth2 redirect URIs for your Dropbox app must be
// exactly this string:  http://localhost:3017/

oauth2.AuthorizationEndpoint = @"https://www.dropbox.com/oauth2/authorize";
oauth2.TokenEndpoint = @"https://api.dropboxapi.com/oauth2/token";

// Replace this with your actual Dropbox App Key
oauth2.ClientId = @"DROPBOX_APP_KEY";

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

// Add token_access_type=offline to also get a refresh token in the response
[oauth2 AddAuthQueryParam: @"token_access_type" value: @"offline"];

// Begin the OAuth2 Authorization code 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);

// 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 == NO) {
    NSLog(@"%@",oauth2.LastErrorText);
    return;
}

// Wait for the user to approve or deny authorization in the browser.
int numMsWaited = 0;
while ((numMsWaited < 90000) && ([oauth2.AuthFlowState intValue] < 3)) {
    [oauth2 SleepMs: [NSNumber numberWithInt: 100]];
    numMsWaited = numMsWaited + 100;
}

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

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

NSLog(@"%@",@"OAuth2 authorization granted!");

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json Load: oauth2.AccessTokenResponse];
json.EmitCompact = NO;

NSLog(@"%@%@",@"Access Token Response = ",[json Emit]);

// A sample access token response:

// {
//   "access_token": "...",
//   "token_type": "bearer",
//   "expires_in": 14399,
//   "refresh_token": "...",
//   "scope": "account_info.read",
//   "uid": "562542581",
//   "account_id": "dbid:AACQhDS0E3_Vb72Ynd0F-GxGWdTI2qcTHzA"
// }

NSLog(@"%@%@",@"Access Token = ",oauth2.AccessToken);

// Save the JSON access token response to a file for subsequent use..
[json WriteFile: @"qa_data/tokens/dropbox.json"];