|
|
(PowerBuilder) 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/
integer li_rc
oleobject loo_Oauth2
integer li_Success
string ls_Url
integer li_NumMsWaited
oleobject loo_SbJson
// 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.
loo_Oauth2 = create oleobject
// Use "Chilkat_9_5_0.OAuth2" for versions of Chilkat < 10.0.0
li_rc = loo_Oauth2.ConnectToNewObject("Chilkat.OAuth2")
if li_rc < 0 then
destroy loo_Oauth2
MessageBox("Error","Connecting to COM object failed")
return
end if
// 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'] );
// ?>
loo_Oauth2.AppCallbackUrl = "https://yourwebserver.com/OAuth2.php"
loo_Oauth2.ListenPort = 3017
loo_Oauth2.AuthorizationEndpoint = "https://api.login.yahoo.com/oauth2/request_auth"
loo_Oauth2.TokenEndpoint = "https://api.login.yahoo.com/oauth2/get_token"
// Replace these with actual values.
loo_Oauth2.ClientId = "CLIENT_ID"
loo_Oauth2.ClientSecret = "CLIENT_SECRET"
// Do not send the "scope" query param for Yahoo OAuth2.
loo_Oauth2.UncommonOptions = "NO_OAUTH2_SCOPE"
// Begin the OAuth2 three-legged flow. This returns a URL that should be loaded in a browser.
ls_Url = loo_Oauth2.StartAuth()
if loo_Oauth2.LastMethodSuccess <> 1 then
Write-Debug loo_Oauth2.LastErrorText
destroy loo_Oauth2
return
end if
Write-Debug ls_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.
li_NumMsWaited = 0
do while (li_NumMsWaited < 30000) AND (loo_Oauth2.AuthFlowState < 3)
loo_Oauth2.SleepMs(100)
li_NumMsWaited = li_NumMsWaited + 100
loop
// 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 loo_Oauth2.AuthFlowState < 3 then
loo_Oauth2.Cancel()
Write-Debug "No response from the browser!"
destroy loo_Oauth2
return
end if
// 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 loo_Oauth2.AuthFlowState = 5 then
Write-Debug "OAuth2 failed to complete."
Write-Debug loo_Oauth2.FailureInfo
destroy loo_Oauth2
return
end if
if loo_Oauth2.AuthFlowState = 4 then
Write-Debug "OAuth2 authorization was denied."
Write-Debug loo_Oauth2.AccessTokenResponse
destroy loo_Oauth2
return
end if
if loo_Oauth2.AuthFlowState <> 3 then
Write-Debug "Unexpected AuthFlowState:" + string(loo_Oauth2.AuthFlowState)
destroy loo_Oauth2
return
end if
// Save the full JSON access token response to a file.
loo_SbJson = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbJson.ConnectToNewObject("Chilkat.StringBuilder")
loo_SbJson.Append(loo_Oauth2.AccessTokenResponse)
loo_SbJson.WriteFile("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"
// }
Write-Debug "OAuth2 authorization granted!"
Write-Debug "Access Token: " + loo_Oauth2.AccessToken
destroy loo_Oauth2
destroy loo_SbJson
|
