|
|
(PureBasic) Yahoo Mail OAuth2 Access Token for Desktop App
Demonstrates how to get a Yahoo Email OAuth2 access token from a desktop application or script.
This example requires a browser window to be displayed to allow the Yahoo account owner to authorize the access. The code for displaying the web browser is omitted. Suggestions for a few programming languages are provided in code comments. You'll need to add the code to display a web browser and navigate to the URL returned by the call to oauth2.StartAuth. For more information, see https://developer.yahoo.com/oauth2/guide/
IncludeFile "CkOAuth2.pb"
IncludeFile "CkStringBuilder.pb"
Procedure ChilkatExample()
; First, you must define your app in Yahoo Developer (https://developer.yahoo.com/apps/) like this:
; 
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
oauth2.i = CkOAuth2::ckCreate()
If oauth2.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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'] );
; ?>
CkOAuth2::setCkAppCallbackUrl(oauth2, "https://yourwebserver.com/OAuth2.php")
CkOAuth2::setCkListenPort(oauth2, 3017)
CkOAuth2::setCkAuthorizationEndpoint(oauth2, "https://api.login.yahoo.com/oauth2/request_auth")
CkOAuth2::setCkTokenEndpoint(oauth2, "https://api.login.yahoo.com/oauth2/get_token")
; Replace these with actual values.
CkOAuth2::setCkClientId(oauth2, "CLIENT_ID")
CkOAuth2::setCkClientSecret(oauth2, "CLIENT_SECRET")
; Do not send the "scope" query param for Yahoo OAuth2.
CkOAuth2::setCkUncommonOptions(oauth2, "NO_OAUTH2_SCOPE")
; 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
; 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 Google 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...
; System.Diagnostics.Process.Start(url);
; Now wait for the authorization.
; We'll wait for a max of 30 seconds.
numMsWaited.i = 0
While (numMsWaited < 30000) AND (CkOAuth2::ckAuthFlowState(oauth2) < 3)
CkOAuth2::ckSleepMs(oauth2,100)
numMsWaited = numMsWaited + 100
Wend
; If there was no response from the browser within 30 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 CkOAuth2::ckAuthFlowState(oauth2) < 3
CkOAuth2::ckCancel(oauth2)
Debug "No response from the browser!"
CkOAuth2::ckDispose(oauth2)
ProcedureReturn
EndIf
; 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 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
; 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/yahooMail.json","utf-8",0)
; The saved JSON response looks like this:
; {
; "access_token": "kCVQdnOdul...LHucA--",
; "refresh_token": "AIenVXETSo0jklFBVkPS8vVm8E.Ej9ToRG.xDbDYmZ65WIs5t6CZhDrD",
; "expires_in": 3600,
; "token_type": "bearer",
; "xoauth_yahoo_guid": "HGDQCVF5JB4YDOWHITQJFBHCWA"
; }
Debug "OAuth2 authorization granted!"
Debug "Access Token: " + CkOAuth2::ckAccessToken(oauth2)
CkOAuth2::ckDispose(oauth2)
CkStringBuilder::ckDispose(sbJson)
ProcedureReturn
EndProcedure
|
