|
|
(DataFlex) 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/
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoOauth2
Boolean iSuccess
String sUrl
Integer iNumMsWaited
Handle hoSbJson
String sTemp1
Integer iTemp1
Boolean bTemp1
// 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.
Get Create (RefClass(cComChilkatOAuth2)) To hoOauth2
If (Not(IsComObjectCreated(hoOauth2))) Begin
Send CreateComObject of hoOauth2
End
// 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'] );
// ?>
Set ComAppCallbackUrl Of hoOauth2 To "https://yourwebserver.com/OAuth2.php"
Set ComListenPort Of hoOauth2 To 3017
Set ComAuthorizationEndpoint Of hoOauth2 To "https://api.login.yahoo.com/oauth2/request_auth"
Set ComTokenEndpoint Of hoOauth2 To "https://api.login.yahoo.com/oauth2/get_token"
// Replace these with actual values.
Set ComClientId Of hoOauth2 To "CLIENT_ID"
Set ComClientSecret Of hoOauth2 To "CLIENT_SECRET"
// Do not send the "scope" query param for Yahoo OAuth2.
Set ComUncommonOptions Of hoOauth2 To "NO_OAUTH2_SCOPE"
// Begin the OAuth2 three-legged flow. This returns a URL that should be loaded in a browser.
Get ComStartAuth Of hoOauth2 To sUrl
Get ComLastMethodSuccess Of hoOauth2 To bTemp1
If (bTemp1 <> True) Begin
Get ComLastErrorText Of hoOauth2 To sTemp1
Showln sTemp1
Procedure_Return
End
Showln sUrl
// 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.
Move 0 To iNumMsWaited
While ((iNumMsWaited < 30000) And ((ComAuthFlowState(hoOauth2)) < 3))
Send ComSleepMs To hoOauth2 100
Move (iNumMsWaited + 100) To iNumMsWaited
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.
Get ComAuthFlowState Of hoOauth2 To iTemp1
If (iTemp1 < 3) Begin
Get ComCancel Of hoOauth2 To iSuccess
Showln "No response from the browser!"
Procedure_Return
End
// 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.
Get ComAuthFlowState Of hoOauth2 To iTemp1
If (iTemp1 = 5) Begin
Showln "OAuth2 failed to complete."
Get ComFailureInfo Of hoOauth2 To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComAuthFlowState Of hoOauth2 To iTemp1
If (iTemp1 = 4) Begin
Showln "OAuth2 authorization was denied."
Get ComAccessTokenResponse Of hoOauth2 To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComAuthFlowState Of hoOauth2 To iTemp1
If (iTemp1 <> 3) Begin
Get ComAuthFlowState Of hoOauth2 To iTemp1
Showln "Unexpected AuthFlowState:" iTemp1
Procedure_Return
End
// Save the full JSON access token response to a file.
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbJson
If (Not(IsComObjectCreated(hoSbJson))) Begin
Send CreateComObject of hoSbJson
End
Get ComAccessTokenResponse Of hoOauth2 To sTemp1
Get ComAppend Of hoSbJson sTemp1 To iSuccess
Get ComWriteFile Of hoSbJson "qa_data/tokens/yahooMail.json" "utf-8" False To iSuccess
// 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"
// }
Showln "OAuth2 authorization granted!"
Get ComAccessToken Of hoOauth2 To sTemp1
Showln "Access Token: " sTemp1
End_Procedure
|
