(Perl) Get Ebay OAuth2 in a Desktop App

See more eBay Examples

There are two ways of "minting" an OAuth2 access token.

1. The authorization code grant flow (this example) (https://developer.ebay.com/api-docs/static/oauth-authorization-code-grant.html) This is where your app will be accessing another person's eBay account. It's an interactive process and requires the account owner's permission to get the access token the 1st time. After that, it can be refreshed indefinitely without user interaction.
2. The client credentials grant flow (https://developer.ebay.com/api-docs/static/oauth-client-credentials-grant.html) This is where you access your own eBay account. It's non-interactive and you can do it in automated services where user-interaction is not possible.

For more information, see https://developer.ebay.com/api-docs/static/oauth-authorization-code-grant.html

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux

use chilkat();

# To further clarify, see OAuth 2.0 Authorization Flow

$oauth2 = chilkat::CkOAuth2->new();

# See the Ebay documentation about Access token types
# Also see the Ebay documentation about authorization code grant flow

# Given that Ebay only allows redirect URLs using SSL/TLS, your applicaton must use an intermediate public web server (your own)
# to receive and forward the redirect to localhost.
# See Using Your Web Server as an Intermediary for OAuth2 Redirect to localhost
# 

# Ebay is unusual in that it wants the redirect URL indirectly.
# You need to provide the RuName (eBay Redirect URL name)
$oauth2->put_AppCallbackUrl("Chilkat_Softwar-ChilkatS-Chilka-wxoumqdu");
$oauth2->put_ListenPort(3017);

$oauth2->put_AuthorizationEndpoint("https://auth.sandbox.ebay.com/oauth2/authorize");
$oauth2->put_TokenEndpoint("https://api.sandbox.ebay.com/identity/v1/oauth2/token");

# Replace these with actual values.
$oauth2->put_ClientId("EBAY_CLIENT_ID");
$oauth2->put_ClientSecret("EBAY_CLIENT_SECRET");
$oauth2->put_UseBasicAuth(1);
$oauth2->put_CodeChallenge(0);

# The scope query param indicates the access to be provided by the token.
# Multiple scopes can be specified by separating each with a SPACE char.
# See the Ebay OAuth scopes documentation

$oauth2->put_Scope("https://api.ebay.com/oauth/api_scope https://api.ebay.com/oauth/api_scope/buy.order.readonly https://api.ebay.com/oauth/api_scope/buy.guest.order https://api.ebay.com/oauth/api_scope/sell.marketing.readonly https://api.ebay.com/oauth/api_scope/sell.marketing https://api.ebay.com/oauth/api_scope/sell.inventory.readonly https://api.ebay.com/oauth/api_scope/sell.inventory https://api.ebay.com/oauth/api_scope/sell.account.readonly https://api.ebay.com/oauth/api_scope/sell.account https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly https://api.ebay.com/oauth/api_scope/sell.fulfillment https://api.ebay.com/oauth/api_scope/sell.analytics.readonly https://api.ebay.com/oauth/api_scope/sell.marketplace.insights.readonly https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly https://api.ebay.com/oauth/api_scope/buy.shopping.cart https://api.ebay.com/oauth/api_scope/buy.offer.auction");

# Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
$url = $oauth2->startAuth();
if ($oauth2->get_LastMethodSuccess() != 1) {
    print $oauth2->lastErrorText() . "\r\n";
    exit;
}

print "url = " . $url . "\r\n";

# 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 == 0) {
    print $oauth2->lastErrorText() . "\r\n";
    exit;
}

# Wait for the user to approve or deny authorization in the browser.
$numMsWaited = 0;
while (($numMsWaited < 90000) and ($oauth2->get_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->get_AuthFlowState() < 3) {
    $oauth2->Cancel();
    print "No response from the browser!" . "\r\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->get_AuthFlowState() == 5) {
    print "OAuth2 failed to complete." . "\r\n";
    print $oauth2->failureInfo() . "\r\n";
    exit;
}

if ($oauth2->get_AuthFlowState() == 4) {
    print "OAuth2 authorization was denied." . "\r\n";
    print $oauth2->accessTokenResponse() . "\r\n";
    exit;
}

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

print "OAuth2 authorization granted!" . "\r\n";
print "Access Token = " . $oauth2->accessToken() . "\r\n";

# Save the full JSON access token response to a file.
$sbJson = chilkat::CkStringBuilder->new();
$sbJson->Append($oauth2->accessTokenResponse());
$sbJson->WriteFile("qa_data/tokens/ebay-access-token.json","utf-8",0);

# The full JSON received looks like this:
# {
#   "access_token": "v^1.1#i^1#p^3#f^0#I^3#r^0#t^H4sIAAA... 3+fBIAAA==",
#   "expires_in": 7200,
#   "refresh_token": "v^1.1#i^1#f^0#p^3#r^1#I^3#t^Ul4xMF8wOkIxQzAzQjg1ND ... fMSNFXjEyODQ=",
#   "refresh_token_expires_in": 47304000,
#   "token_type": "User Access Token"
# }