![]() |
Chilkat HOME Android™ AutoIt C C# C++ Chilkat2-Python CkPython Classic ASP DataFlex Delphi DLL Go Java Node.js Objective-C PHP Extension Perl PowerBuilder PowerShell PureBasic Ruby SQL Server Swift Tcl Unicode C Unicode C++ VB.NET VBScript Visual Basic 6.0 Visual FoxPro Xojo Plugin
(PureBasic) Get Ebay OAuth2 in a Desktop AppSee more eBay ExamplesDemonstrates how to get a Ebay OAuth2 access token from a desktop application or script.There are two ways of "minting" an OAuth2 access token.
For more information, see https://developer.ebay.com/api-docs/static/oauth-authorization-code-grant.html
IncludeFile "CkOAuth2.pb" IncludeFile "CkStringBuilder.pb" Procedure ChilkatExample() ; To further clarify, see OAuth 2.0 Authorization Flow oauth2.i = CkOAuth2::ckCreate() If oauth2.i = 0 Debug "Failed to create object." ProcedureReturn EndIf ; 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) CkOAuth2::setCkAppCallbackUrl(oauth2, "Chilkat_Softwar-ChilkatS-Chilka-wxoumqdu") CkOAuth2::setCkListenPort(oauth2, 3017) CkOAuth2::setCkAuthorizationEndpoint(oauth2, "https://auth.sandbox.ebay.com/oauth2/authorize") CkOAuth2::setCkTokenEndpoint(oauth2, "https://api.sandbox.ebay.com/identity/v1/oauth2/token") ; Replace these with actual values. CkOAuth2::setCkClientId(oauth2, "EBAY_CLIENT_ID") CkOAuth2::setCkClientSecret(oauth2, "EBAY_CLIENT_SECRET") CkOAuth2::setCkUseBasicAuth(oauth2, 1) CkOAuth2::setCkCodeChallenge(oauth2, 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 CkOAuth2::setCkScope(oauth2, "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.s = CkOAuth2::ckStartAuth(oauth2) If CkOAuth2::ckLastMethodSuccess(oauth2) <> 1 Debug CkOAuth2::ckLastErrorText(oauth2) CkOAuth2::ckDispose(oauth2) ProcedureReturn EndIf Debug "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.i = CkOAuth2::ckLaunchBrowser(oauth2,url) If success = 0 Debug CkOAuth2::ckLastErrorText(oauth2) CkOAuth2::ckDispose(oauth2) ProcedureReturn EndIf ; Wait for the user to approve or deny authorization in the browser. numMsWaited.i = 0 While (numMsWaited < 90000) AND (CkOAuth2::ckAuthFlowState(oauth2) < 3) CkOAuth2::ckSleepMs(oauth2,100) numMsWaited = numMsWaited + 100 Wend ; 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::ckAuthFlowState(oauth2) < 3 CkOAuth2::ckCancel(oauth2) Debug "No response from the browser!" CkOAuth2::ckDispose(oauth2) ProcedureReturn EndIf ; 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::ckAuthFlowState(oauth2) = 5 Debug "OAuth2 failed to complete." Debug CkOAuth2::ckFailureInfo(oauth2) CkOAuth2::ckDispose(oauth2) ProcedureReturn EndIf If CkOAuth2::ckAuthFlowState(oauth2) = 4 Debug "OAuth2 authorization was denied." Debug CkOAuth2::ckAccessTokenResponse(oauth2) CkOAuth2::ckDispose(oauth2) ProcedureReturn EndIf If CkOAuth2::ckAuthFlowState(oauth2) <> 3 Debug "Unexpected AuthFlowState:" + Str(CkOAuth2::ckAuthFlowState(oauth2)) CkOAuth2::ckDispose(oauth2) ProcedureReturn EndIf Debug "OAuth2 authorization granted!" Debug "Access Token = " + CkOAuth2::ckAccessToken(oauth2) ; Save the full JSON access token response to a file. sbJson.i = CkStringBuilder::ckCreate() If sbJson.i = 0 Debug "Failed to create object." ProcedureReturn EndIf CkStringBuilder::ckAppend(sbJson,CkOAuth2::ckAccessTokenResponse(oauth2)) CkStringBuilder::ckWriteFile(sbJson,"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" ; } CkOAuth2::ckDispose(oauth2) CkStringBuilder::ckDispose(sbJson) ProcedureReturn EndProcedure |
© 2000-2025 Chilkat Software, Inc. All Rights Reserved.