|
|
(SQL Server) 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/
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- 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.
DECLARE @oauth2 int
-- Use "Chilkat_9_5_0.OAuth2" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.OAuth2', @oauth2 OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- 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'] );
-- ?>
EXEC sp_OASetProperty @oauth2, 'AppCallbackUrl', 'https://yourwebserver.com/OAuth2.php'
EXEC sp_OASetProperty @oauth2, 'ListenPort', 3017
EXEC sp_OASetProperty @oauth2, 'AuthorizationEndpoint', 'https://api.login.yahoo.com/oauth2/request_auth'
EXEC sp_OASetProperty @oauth2, 'TokenEndpoint', 'https://api.login.yahoo.com/oauth2/get_token'
-- Replace these with actual values.
EXEC sp_OASetProperty @oauth2, 'ClientId', 'CLIENT_ID'
EXEC sp_OASetProperty @oauth2, 'ClientSecret', 'CLIENT_SECRET'
-- Do not send the "scope" query param for Yahoo OAuth2.
EXEC sp_OASetProperty @oauth2, 'UncommonOptions', 'NO_OAUTH2_SCOPE'
-- Begin the OAuth2 three-legged flow. This returns a URL that should be loaded in a browser.
DECLARE @url nvarchar(4000)
EXEC sp_OAMethod @oauth2, 'StartAuth', @url OUT
EXEC sp_OAGetProperty @oauth2, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 <> 1
BEGIN
EXEC sp_OAGetProperty @oauth2, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @oauth2
RETURN
END
PRINT @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.
DECLARE @numMsWaited int
SELECT @numMsWaited = 0
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
WHILE (@numMsWaited < 30000) and (@iTmp0 < 3)
BEGIN
EXEC sp_OAMethod @oauth2, 'SleepMs', NULL, 100
SELECT @numMsWaited = @numMsWaited + 100
END
-- 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.
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
IF @iTmp0 < 3
BEGIN
EXEC sp_OAMethod @oauth2, 'Cancel', @success OUT
PRINT 'No response from the browser!'
EXEC @hr = sp_OADestroy @oauth2
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.
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
IF @iTmp0 = 5
BEGIN
PRINT 'OAuth2 failed to complete.'
EXEC sp_OAGetProperty @oauth2, 'FailureInfo', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @oauth2
RETURN
END
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
IF @iTmp0 = 4
BEGIN
PRINT 'OAuth2 authorization was denied.'
EXEC sp_OAGetProperty @oauth2, 'AccessTokenResponse', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @oauth2
RETURN
END
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
IF @iTmp0 <> 3
BEGIN
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
PRINT 'Unexpected AuthFlowState:' + @iTmp0
EXEC @hr = sp_OADestroy @oauth2
RETURN
END
-- Save the full JSON access token response to a file.
DECLARE @sbJson int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbJson OUT
EXEC sp_OAGetProperty @oauth2, 'AccessTokenResponse', @sTmp0 OUT
EXEC sp_OAMethod @sbJson, 'Append', @success OUT, @sTmp0
EXEC sp_OAMethod @sbJson, 'WriteFile', @success OUT, '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"
-- }
PRINT 'OAuth2 authorization granted!'
EXEC sp_OAGetProperty @oauth2, 'AccessToken', @sTmp0 OUT
PRINT 'Access Token: ' + @sTmp0
EXEC @hr = sp_OADestroy @oauth2
EXEC @hr = sp_OADestroy @sbJson
END
GO
|
