Perl Requires Chilkat v10.1.2+

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.

Chilkat2 Perl

use strict;
use warnings;
use Chilkat2;

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

my $oauth2 = Chilkat2::OAuth2->new;

# The port should match the Authorized Redirect URL in your Dropbox app,
# which would look like "http://localhost:3017/"
$oauth2->ListenPort(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(1);
$oauth2->CodeChallengeMethod('S256');

# Add token_access_type=offline to also get a refresh token in the response
$oauth2->AddAuthQueryParam('token_access_type', 'offline');

# Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
my $url = $oauth2->StartAuth();
if (!$oauth2->LastMethodSuccess) {
    print $oauth2->LastErrorText, "\n";
    exit;
}

print 'url = ', $url, "\n";

# Launch the default browser on the system and navigate to the url.
my $success = $oauth2->LaunchBrowser($url);
if (!$success) {
    print $oauth2->LastErrorText, "\n";
    exit;
}

# Wait for the user to approve or deny authorization in the browser.
my $numMsWaited = 0;
while (($numMsWaited < 90000) && ($oauth2->AuthFlowState < 3)) {
    $oauth2->SleepMs(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 < 3) {
    $oauth2->Cancel();
    print "No response from the browser!\n";
    exit;
}

# 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) {
    print "OAuth2 failed to complete.\n";
    print $oauth2->FailureInfo, "\n";
    exit;
}

if ($oauth2->AuthFlowState == 4) {
    print "OAuth2 authorization was denied.\n";
    print $oauth2->AccessTokenResponse, "\n";
    exit;
}

if ($oauth2->AuthFlowState != 3) {
    print 'Unexpected AuthFlowState:', $oauth2->AuthFlowState, "\n";
    exit;
}

print "OAuth2 authorization granted!\n";

my $json = Chilkat2::JsonObject->new;
$json->Load($oauth2->AccessTokenResponse);
$json->EmitCompact(0);

print 'Access Token Response = ', $json->Emit(), "\n";

# 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"
# }

print 'Access Token = ', $oauth2->AccessToken, "\n";

# Save the JSON access token response to a file for subsequent use..
$json->WriteFile('qa_data/tokens/dropbox.json');