(SQL Server) Wish for Merchants -- Get OAuth2 Access Token for Desktop App

Demonstrates how to get a Wish for Merchants OAuth2 access token from a desktop application or script.

Note: This example requires Chilkat v10.1.2 or greater.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- 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)
    -- To further clarify, see OAuth 2.0 Authorization Flow

    -- This example is for desktop applicatons (it is not for code that runs on a web server).

    -- This is the way to initially obtain the OAuth2 access token.  Afterwards it can be 
    -- repeatedly refreshed without user interaction, as shown in this example: Refresh Wish OAuth2 Access Token.

    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

    -- Wish OAuth2 does not allow a localhost callback URI such as "http://localhost:<portNumber>/"
    -- For a desktop app, you must provide a script on your web server to redirect to "http://localhost/<portNumber>"

    -- Your applicaton must use your own public web server as an intermediate
    -- to receive and forward the redirect to localhost.
    -- See Using Your Web Server as an Intermediary for OAuth2 Redirect to localhost
    EXEC sp_OASetProperty @oauth2, 'AppCallbackUrl', 'https://yourwebserver.com/OAuth2.php'
    EXEC sp_OASetProperty @oauth2, 'ListenPort', 3017

    EXEC sp_OASetProperty @oauth2, 'AuthorizationEndpoint', 'https://merchant.wish.com/v3/oauth/authorize'
    EXEC sp_OASetProperty @oauth2, 'TokenEndpoint', 'https://merchant.wish.com/api/v3/oauth/access_token'

    EXEC sp_OASetProperty @oauth2, 'UncommonOptions', 'EXCHANGE_CODE_FOR_TOKEN_USING_GET'

    -- Replace these with actual values.
    EXEC sp_OASetProperty @oauth2, 'ClientId', 'WISH-CLIENT-ID'
    EXEC sp_OASetProperty @oauth2, 'ClientSecret', 'WISH-CLIENT-SECRET'

    EXEC sp_OASetProperty @oauth2, 'Scope', ''

    -- Begin the OAuth2 Authorization code 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 = ' + @url

    -- Launch the default browser on the system and navigate to the url.
    -- The LaunchBrowser method was added in Chilkat v10.1.2.
    DECLARE @success int
    EXEC sp_OAMethod @oauth2, 'LaunchBrowser', @success OUT, @url
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @oauth2, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @oauth2
        RETURN
      END

    -- Wait for the user to approve or deny authorization in the browser.
    DECLARE @numMsWaited int
    SELECT @numMsWaited = 0
    EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
    WHILE (@numMsWaited < 90000) and (@iTmp0 < 3)
      BEGIN
        EXEC sp_OAMethod @oauth2, 'SleepMs', NULL, 100
        SELECT @numMsWaited = @numMsWaited + 100
      END

    -- 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.

    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 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.

    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/wish.json', 'utf-8', 0

    -- The full JSON received looks like this:
    -- {
    --   "message": "",
    --   "code": 0,
    --   "data": {
    --     "access_token": "15af1c191c1243b029bc1660b5c08ce7",
    --     "scopes": [
    --       "epc:read",
    --       "epc:write",
    --       "fbs:read",
    --       "fbs:write",
    --       "fbw:read",
    --       "fbw:write",
    --       "infractions:read",
    --       "infractions:write",
    --       "insurance:read",
    --       "insurance:write",
    --       "loans:read",
    --       "loans:write",
    --       "merchant:read",
    --       "merchant:write",
    --       "notifications:read",
    --       "notifications:write",
    --       "orders:read",
    --       "orders:write",
    --       "payments:read",
    --       "payments:write",
    --       "penalties:read",
    --       "penalties:write",
    --       "product_boost:read",
    --       "product_boost:write",
    --       "products:read",
    --       "products:write",
    --       "ratings:read",
    --       "ratings:write",
    --       "returns:read",
    --       "returns:write",
    --       "tickets:read",
    --       "tickets:write"
    --     ],
    --     "merchant_id": "5eb3f605178f5be2c784fa02",
    --     "expiry_time": "2020-12-17T16:55:09.594+00:00",
    --     "refresh_token": "55a38e44df674a1e859891624b2c4c23"
    --   }
    -- }


    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