SQL Server
SQL Server
TikTok Shop OAuth2
See more TikTok Shop Examples
Demonstrates how to get the initial OAuth2 access token for a TikTop Shop application. This is for desktop applications and scripts only. It is not for server-side code running on a web server.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
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
DECLARE @success int
SELECT @success = 0
-- This example requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @oauth2 int
EXEC @hr = sp_OACreate 'Chilkat.OAuth2', @oauth2 OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
-- This should be the port in the localhost callback URL for your app.
-- The callback URL would look like "http://localhost:3017/" if the port number is 3017.
EXEC sp_OASetProperty @oauth2, 'ListenPort', 3017
EXEC sp_OASetProperty @oauth2, 'AuthorizationEndpoint', 'https://services.tiktokshop.com/open/authorize'
EXEC sp_OASetProperty @oauth2, 'TokenEndpoint', 'https://auth.tiktok-shops.com/api/v2/token/get'
-- Replace these with actual values.
EXEC sp_OASetProperty @oauth2, 'ClientId', 'APP_KEY'
EXEC sp_OASetProperty @oauth2, 'ClientSecret', 'APP_SECRET'
EXEC sp_OASetProperty @oauth2, 'Scope', ''
-- See https://partner.tiktokshop.com/doc/page/63fd743c715d622a338c4e5a
-- for information about how to manually get your service_id
-- Once you have the service_id, it should not change.
EXEC sp_OAMethod @oauth2, 'AddAuthQueryParam', @success OUT, 'service_id', 'YOUR_SERVICE_ID'
-- 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 = 0
BEGIN
EXEC sp_OAGetProperty @oauth2, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @oauth2
RETURN
END
-- Launch the system's default browser navigated to the URL.
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
-- Now wait for the authorization.
-- We'll wait for a max of 60 seconds.
DECLARE @numMsWaited int
SELECT @numMsWaited = 0
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
WHILE (@numMsWaited < 60000) 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
PRINT 'OAuth2 authorization granted!'
EXEC sp_OAGetProperty @oauth2, 'AccessToken', @sTmp0 OUT
PRINT 'Access Token = ' + @sTmp0
-- Get the full JSON response:
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAGetProperty @oauth2, 'AccessTokenResponse', @sTmp0 OUT
EXEC sp_OAMethod @json, 'Load', @success OUT, @sTmp0
EXEC sp_OASetProperty @json, 'EmitCompact', 0
-- The JSON response looks like this:
-- {
-- "code": 0,
-- "message": "success",
-- "data": {
-- "access_token": "GCP_3n......",
-- "access_token_expire_in": 1722342011,
-- "refresh_token": "GCP_hA......",
-- "refresh_token_expire_in": 4841467787,
-- "open_id": "_VIz.......",
-- "seller_name": "****",
-- "seller_base_region": "GB",
-- "user_type": 0,
-- "granted_scopes": [
-- "seller.authorization.info",
-- "seller.delivery.status.write",
-- "seller.product.basic",
-- "seller.order.info",
-- "seller.fulfillment.basic",
-- "seller.shop.info",
-- "seller.fulfillment.package.write",
-- "seller.product.write"
-- ]
-- },
-- "request_id": "20240723......"
-- }
EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
PRINT @sTmp0
-- How to get values from the JSON:
DECLARE @strVal nvarchar(4000)
DECLARE @code int
EXEC sp_OAMethod @json, 'IntOf', @code OUT, 'code'
DECLARE @message nvarchar(4000)
EXEC sp_OAMethod @json, 'StringOf', @message OUT, 'message'
DECLARE @Access_token nvarchar(4000)
EXEC sp_OAMethod @json, 'StringOf', @Access_token OUT, 'data.access_token'
DECLARE @Access_token_expire_in int
EXEC sp_OAMethod @json, 'IntOf', @Access_token_expire_in OUT, 'data.access_token_expire_in'
DECLARE @Refresh_token nvarchar(4000)
EXEC sp_OAMethod @json, 'StringOf', @Refresh_token OUT, 'data.refresh_token'
DECLARE @Refresh_token_expire_in int
EXEC sp_OAMethod @json, 'IntOf', @Refresh_token_expire_in OUT, 'data.refresh_token_expire_in'
DECLARE @Open_id nvarchar(4000)
EXEC sp_OAMethod @json, 'StringOf', @Open_id OUT, 'data.open_id'
DECLARE @Seller_name nvarchar(4000)
EXEC sp_OAMethod @json, 'StringOf', @Seller_name OUT, 'data.seller_name'
DECLARE @Seller_base_region nvarchar(4000)
EXEC sp_OAMethod @json, 'StringOf', @Seller_base_region OUT, 'data.seller_base_region'
DECLARE @User_type int
EXEC sp_OAMethod @json, 'IntOf', @User_type OUT, 'data.user_type'
DECLARE @request_id nvarchar(4000)
EXEC sp_OAMethod @json, 'StringOf', @request_id OUT, 'request_id'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @json, 'SizeOfArray', @count_i OUT, 'data.granted_scopes'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @json, 'I', @i
EXEC sp_OAMethod @json, 'StringOf', @strVal OUT, 'data.granted_scopes[i]'
SELECT @i = @i + 1
END
-- Save the JSON to a file for future requests, if needed..
DECLARE @fac int
EXEC @hr = sp_OACreate 'Chilkat.FileAccess', @fac OUT
EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
EXEC sp_OAMethod @fac, 'WriteEntireTextFile', @success OUT, 'qa_data/tokens/tiktok-shops.json', @sTmp0, 'utf-8', 0
EXEC @hr = sp_OADestroy @oauth2
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @fac
END
GO