Tcl

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

load ./chilkat.dll

set success 0

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

set oauth2 [new_CkOAuth2]

# 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.
CkOAuth2_put_ListenPort $oauth2 3017

CkOAuth2_put_AuthorizationEndpoint $oauth2 "https://services.tiktokshop.com/open/authorize"
CkOAuth2_put_TokenEndpoint $oauth2 "https://auth.tiktok-shops.com/api/v2/token/get"

# Replace these with actual values.
CkOAuth2_put_ClientId $oauth2 "APP_KEY"
CkOAuth2_put_ClientSecret $oauth2 "APP_SECRET"

CkOAuth2_put_Scope $oauth2 ""

# 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.
CkOAuth2_AddAuthQueryParam $oauth2 "service_id" "YOUR_SERVICE_ID"

# Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
set url [CkOAuth2_startAuth $oauth2]
if {[CkOAuth2_get_LastMethodSuccess $oauth2] == 0} then {
    puts [CkOAuth2_lastErrorText $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

# Launch the system's default browser navigated to the URL.
set success [CkOAuth2_LaunchBrowser $oauth2 $url]
if {$success == 0} then {
    puts [CkOAuth2_lastErrorText $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

# Now wait for the authorization.
# We'll wait for a max of 60 seconds.
set numMsWaited 0
while {expr [$numMsWaited < 60000]  &&  [[CkOAuth2_get_AuthFlowState $oauth2] < 3]} {
    CkOAuth2_SleepMs $oauth2 100
    set numMsWaited [expr $numMsWaited + 100]
}

# 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 {[CkOAuth2_get_AuthFlowState $oauth2] < 3} then {
    CkOAuth2_Cancel $oauth2
    puts "No response from the browser!"
    delete_CkOAuth2 $oauth2
    exit
}

# 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 {[CkOAuth2_get_AuthFlowState $oauth2] == 5} then {
    puts "OAuth2 failed to complete."
    puts [CkOAuth2_failureInfo $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

if {[CkOAuth2_get_AuthFlowState $oauth2] == 4} then {
    puts "OAuth2 authorization was denied."
    puts [CkOAuth2_accessTokenResponse $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

if {[CkOAuth2_get_AuthFlowState $oauth2] != 3} then {
    puts "Unexpected AuthFlowState:[CkOAuth2_get_AuthFlowState $oauth2]"
    delete_CkOAuth2 $oauth2
    exit
}

puts "OAuth2 authorization granted!"
puts "Access Token = [CkOAuth2_accessToken $oauth2]"

# Get the full JSON response:
set json [new_CkJsonObject]

CkJsonObject_Load $json [CkOAuth2_accessTokenResponse $oauth2]
CkJsonObject_put_EmitCompact $json 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......"
# }

puts [CkJsonObject_emit $json]

# How to get values from the JSON:

set code [CkJsonObject_IntOf $json "code"]
set message [CkJsonObject_stringOf $json "message"]
set Access_token [CkJsonObject_stringOf $json "data.access_token"]
set Access_token_expire_in [CkJsonObject_IntOf $json "data.access_token_expire_in"]
set Refresh_token [CkJsonObject_stringOf $json "data.refresh_token"]
set Refresh_token_expire_in [CkJsonObject_IntOf $json "data.refresh_token_expire_in"]
set Open_id [CkJsonObject_stringOf $json "data.open_id"]
set Seller_name [CkJsonObject_stringOf $json "data.seller_name"]
set Seller_base_region [CkJsonObject_stringOf $json "data.seller_base_region"]
set User_type [CkJsonObject_IntOf $json "data.user_type"]
set request_id [CkJsonObject_stringOf $json "request_id"]
set i 0
set count_i [CkJsonObject_SizeOfArray $json "data.granted_scopes"]
while {$i < $count_i} {
    CkJsonObject_put_I $json $i
    set strVal [CkJsonObject_stringOf $json "data.granted_scopes[i]"]
    set i [expr $i + 1]
}

# Save the JSON to a file for future requests, if needed..
set fac [new_CkFileAccess]

CkFileAccess_WriteEntireTextFile $fac "qa_data/tokens/tiktok-shops.json" [CkJsonObject_emit $json] "utf-8" 0

delete_CkOAuth2 $oauth2
delete_CkJsonObject $json
delete_CkFileAccess $fac