AutoIt

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

Local $bSuccess = False

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

$oOauth2 = ObjCreate("Chilkat.OAuth2")

; 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.
$oOauth2.ListenPort = 3017

$oOauth2.AuthorizationEndpoint = "https://services.tiktokshop.com/open/authorize"
$oOauth2.TokenEndpoint = "https://auth.tiktok-shops.com/api/v2/token/get"

; Replace these with actual values.
$oOauth2.ClientId = "APP_KEY"
$oOauth2.ClientSecret = "APP_SECRET"

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

; Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
Local $sUrl = $oOauth2.StartAuth()
If ($oOauth2.LastMethodSuccess = False) Then
    ConsoleWrite($oOauth2.LastErrorText & @CRLF)
    Exit
EndIf

; Launch the system's default browser navigated to the URL.
$bSuccess = $oOauth2.LaunchBrowser($sUrl)
If ($bSuccess = False) Then
    ConsoleWrite($oOauth2.LastErrorText & @CRLF)
    Exit
EndIf

; Now wait for the authorization.
; We'll wait for a max of 60 seconds.
Local $iNumMsWaited = 0
While ($iNumMsWaited < 60000) And ($oOauth2.AuthFlowState < 3)
    $oOauth2.SleepMs 100
    $iNumMsWaited = $iNumMsWaited + 100
Wend

; 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 ($oOauth2.AuthFlowState < 3) Then
    $oOauth2.Cancel()
    ConsoleWrite("No response from the browser!" & @CRLF)
    Exit
EndIf

; 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 ($oOauth2.AuthFlowState = 5) Then
    ConsoleWrite("OAuth2 failed to complete." & @CRLF)
    ConsoleWrite($oOauth2.FailureInfo & @CRLF)
    Exit
EndIf

If ($oOauth2.AuthFlowState = 4) Then
    ConsoleWrite("OAuth2 authorization was denied." & @CRLF)
    ConsoleWrite($oOauth2.AccessTokenResponse & @CRLF)
    Exit
EndIf

If ($oOauth2.AuthFlowState <> 3) Then
    ConsoleWrite("Unexpected AuthFlowState:" & $oOauth2.AuthFlowState & @CRLF)
    Exit
EndIf

ConsoleWrite("OAuth2 authorization granted!" & @CRLF)
ConsoleWrite("Access Token = " & $oOauth2.AccessToken & @CRLF)

; Get the full JSON response:
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.Load($oOauth2.AccessTokenResponse)
$oJson.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......"
; }

ConsoleWrite($oJson.Emit() & @CRLF)

; How to get values from the JSON:
Local $strVal

Local $iCode = $oJson.IntOf("code")
Local $sMessage = $oJson.StringOf("message")
Local $sAccess_token = $oJson.StringOf("data.access_token")
Local $iAccess_token_expire_in = $oJson.IntOf("data.access_token_expire_in")
Local $sRefresh_token = $oJson.StringOf("data.refresh_token")
Local $iRefresh_token_expire_in = $oJson.IntOf("data.refresh_token_expire_in")
Local $sOpen_id = $oJson.StringOf("data.open_id")
Local $sSeller_name = $oJson.StringOf("data.seller_name")
Local $sSeller_base_region = $oJson.StringOf("data.seller_base_region")
Local $iUser_type = $oJson.IntOf("data.user_type")
Local $sRequest_id = $oJson.StringOf("request_id")
Local $i = 0
Local $iCount_i = $oJson.SizeOfArray("data.granted_scopes")
While $i < $iCount_i
    $oJson.I = $i
    $strVal = $oJson.StringOf("data.granted_scopes[i]")
    $i = $i + 1
Wend

; Save the JSON to a file for future requests, if needed..
$oFac = ObjCreate("Chilkat.FileAccess")
$oFac.WriteEntireTextFile("qa_data/tokens/tiktok-shops.json",$oJson.Emit(),"utf-8",False)