(Ruby) 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.

IMPORTANT: This example requires a pre-release for the next version of Chilkat after the current v9.5.0.99 release. Contact info@chilkatsoft.com if you wish to get a pre-release. However, pre-releases of .NET Core (hosted on NuGet) and Node.js will not be possible.

For more information, see https://partner.tiktokshop.com/doc/page/63fd743c715d622a338c4e54

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

oauth2 = Chilkat::CkOAuth2.new()

# 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.
oauth2.put_ListenPort(3017)

oauth2.put_AuthorizationEndpoint("https://services.tiktokshop.com/open/authorize")
oauth2.put_TokenEndpoint("https://auth.tiktok-shops.com/api/v2/token/get")

# Replace these with actual values.
oauth2.put_ClientId("APP_KEY")
oauth2.put_ClientSecret("APP_SECRET")

oauth2.put_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.
oauth2.AddAuthQueryParam("service_id","YOUR_SERVICE_ID")

# Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
url = oauth2.startAuth()
if (oauth2.get_LastMethodSuccess() != true)
    print oauth2.lastErrorText() + "\n";
    exit
end

# -------------------------------------------------------------------
# IMPORTANT:
# 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
# in C++ on Windows: ShellExecute(0, 0, url, 0, 0 , SW_SHOW );

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

# Now wait for the authorization.
# We'll wait for a max of 60 seconds.
numMsWaited = 0
while (numMsWaited < 60000) and (oauth2.get_AuthFlowState() < 3)
    oauth2.SleepMs(100)
    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.
if (oauth2.get_AuthFlowState() < 3)
    oauth2.Cancel()
    print "No response from the browser!" + "\n";
    exit
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.
if (oauth2.get_AuthFlowState() == 5)
    print "OAuth2 failed to complete." + "\n";
    print oauth2.failureInfo() + "\n";
    exit
end

if (oauth2.get_AuthFlowState() == 4)
    print "OAuth2 authorization was denied." + "\n";
    print oauth2.accessTokenResponse() + "\n";
    exit
end

if (oauth2.get_AuthFlowState() != 3)
    print "Unexpected AuthFlowState:" + oauth2.get_AuthFlowState().to_s() + "\n";
    exit
end

print "OAuth2 authorization granted!" + "\n";
print "Access Token = " + oauth2.accessToken() + "\n";

# Get the full JSON response:
json = Chilkat::CkJsonObject.new()
json.Load(oauth2.accessTokenResponse())
json.put_EmitCompact(false)

# 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......"
# }

print json.emit() + "\n";

# How to get values from the JSON:

code = json.IntOf("code")
message = json.stringOf("message")
Access_token = json.stringOf("data.access_token")
Access_token_expire_in = json.IntOf("data.access_token_expire_in")
Refresh_token = json.stringOf("data.refresh_token")
Refresh_token_expire_in = json.IntOf("data.refresh_token_expire_in")
Open_id = json.stringOf("data.open_id")
Seller_name = json.stringOf("data.seller_name")
Seller_base_region = json.stringOf("data.seller_base_region")
User_type = json.IntOf("data.user_type")
request_id = json.stringOf("request_id")
i = 0
count_i = json.SizeOfArray("data.granted_scopes")
while i < count_i
    json.put_I(i)
    strVal = json.stringOf("data.granted_scopes[i]")
    i = i + 1
end

# Save the JSON to a file for future requests, if needed..
fac = Chilkat::CkFileAccess.new()
fac.WriteEntireTextFile("qa_data/tokens/tiktok-shops.json",json.emit(),"utf-8",false)