SQL Server Requires Chilkat v10.1.2+
SQL Server
Quickbooks OAuth2 in a Desktop App
See more QuickBooks Examples
Demonstrates how to get a QuickBooks OAuth2 access token from a desktop application or script.Chilkat SQL Server Downloads
-- 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
DECLARE @sTmp0 nvarchar(4000)
DECLARE @success int
SELECT @success = 0
-- To further clarify, see OAuth 2.0 Authorization Flow
-- ------------------------------------------------------------------------------------------------
-- IMPORTANT: You first need to define an App in the Quickbooks Developer Dashboard.
-- See How to Create an App in QuickBooks Developer Dashboard
-- ------------------------------------------------------------------------------------------------
-- This example is for desktop applicatons (it is not for code that runs on a web server).
-- You'll need to add a line (or a few lines of code) to popup a web browser that navigates to a URL.
-- 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 Quickbooks OAuth2 Access Token.
DECLARE @oauth2 int
EXEC @hr = sp_OACreate 'Chilkat.OAuth2', @oauth2 OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
-- QuickBooks OAuth2 allows for an "http://localhost:<portNumber>/" callback URL for sandbox testing,
-- but not for production.
-- In production, 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://appcenter.intuit.com/connect/oauth2'
EXEC sp_OASetProperty @oauth2, 'TokenEndpoint', 'https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer'
-- Replace these with actual values.
EXEC sp_OASetProperty @oauth2, 'ClientId', 'QUICKBOOKS-CLIENT-ID'
EXEC sp_OASetProperty @oauth2, 'ClientSecret', 'QUICKBOOKS-CLIENT-SECRET'
EXEC sp_OASetProperty @oauth2, 'UseBasicAuth', 1
EXEC sp_OASetProperty @oauth2, 'CodeChallenge', 0
-- Indicate the desired access. Possible scopes that can appear in the list are:
-- com.intuit.quickbooks.accounting: QuickBooks Online API
-- com.intuit.quickbooks.payment: QuickBooks Payments API
-- openid: OpenID Connect processing
-- profile: user's given and family names
-- email: user's email address
-- phone: user's phone number
-- address: user's physical address
EXEC sp_OASetProperty @oauth2, 'Scope', 'com.intuit.quickbooks.accounting'
-- 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 = 0
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.
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
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/qb-access-token.json', 'utf-8', 0
-- The full JSON received looks like this:
-- {
-- "expires_in": 3600,
-- "x_refresh_token_expires_in": 8726400,
-- "refresh_token": "L011546037639r ... 3vR2DrbOmg0Sdagw",
-- "access_token": "eyJlbmMiOiJBMTI4Q0 ... oETJEMbeggg",
-- "token_type": "bearer"
-- }
PRINT 'OAuth2 authorization granted!'
EXEC sp_OAGetProperty @oauth2, 'AccessToken', @sTmp0 OUT
PRINT 'Access Token = ' + @sTmp0
-- Get the realmId if needed...
-- See About the QuickBooks REST API Realm ID, also known as Company ID
DECLARE @realmId nvarchar(4000)
EXEC sp_OAMethod @oauth2, 'GetRedirectRequestParam', @realmId OUT, 'realmId'
EXEC sp_OAGetProperty @oauth2, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 1
BEGIN
PRINT 'realmId: ' + @realmId
END
ELSE
BEGIN
PRINT 'No realmId was provided.'
END
EXEC @hr = sp_OADestroy @oauth2
EXEC @hr = sp_OADestroy @sbJson
END
GO