PowerBuilder

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

integer li_rc
integer li_Success
oleobject loo_Oauth2
string ls_Url
integer li_NumMsWaited
oleobject loo_Json
string ls_StrVal
integer li_Code
string ls_Message
string ls_Access_token
integer li_Access_token_expire_in
string ls_Refresh_token
integer li_Refresh_token_expire_in
string ls_Open_id
string ls_Seller_name
string ls_Seller_base_region
integer li_User_type
string ls_Request_id
integer i
integer li_Count_i
oleobject loo_Fac

li_Success = 0

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

loo_Oauth2 = create oleobject
li_rc = loo_Oauth2.ConnectToNewObject("Chilkat.OAuth2")
if li_rc < 0 then
    destroy loo_Oauth2
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// 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.
loo_Oauth2.ListenPort = 3017

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

// Replace these with actual values.
loo_Oauth2.ClientId = "APP_KEY"
loo_Oauth2.ClientSecret = "APP_SECRET"

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

// Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
ls_Url = loo_Oauth2.StartAuth()
if loo_Oauth2.LastMethodSuccess = 0 then
    Write-Debug loo_Oauth2.LastErrorText
    destroy loo_Oauth2
    return
end if

// Launch the system's default browser navigated to the URL.
li_Success = loo_Oauth2.LaunchBrowser(ls_Url)
if li_Success = 0 then
    Write-Debug loo_Oauth2.LastErrorText
    destroy loo_Oauth2
    return
end if

// Now wait for the authorization.
// We'll wait for a max of 60 seconds.
li_NumMsWaited = 0
do while (li_NumMsWaited < 60000) AND (loo_Oauth2.AuthFlowState < 3)
    loo_Oauth2.SleepMs(100)
    li_NumMsWaited = li_NumMsWaited + 100
loop

// 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 loo_Oauth2.AuthFlowState < 3 then
    loo_Oauth2.Cancel()
    Write-Debug "No response from the browser!"
    destroy loo_Oauth2
    return
end if

// 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 loo_Oauth2.AuthFlowState = 5 then
    Write-Debug "OAuth2 failed to complete."
    Write-Debug loo_Oauth2.FailureInfo
    destroy loo_Oauth2
    return
end if

if loo_Oauth2.AuthFlowState = 4 then
    Write-Debug "OAuth2 authorization was denied."
    Write-Debug loo_Oauth2.AccessTokenResponse
    destroy loo_Oauth2
    return
end if

if loo_Oauth2.AuthFlowState <> 3 then
    Write-Debug "Unexpected AuthFlowState:" + string(loo_Oauth2.AuthFlowState)
    destroy loo_Oauth2
    return
end if

Write-Debug "OAuth2 authorization granted!"
Write-Debug "Access Token = " + loo_Oauth2.AccessToken

// Get the full JSON response:
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.Load(loo_Oauth2.AccessTokenResponse)
loo_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......"
// }

Write-Debug loo_Json.Emit()

// How to get values from the JSON:

li_Code = loo_Json.IntOf("code")
ls_Message = loo_Json.StringOf("message")
ls_Access_token = loo_Json.StringOf("data.access_token")
li_Access_token_expire_in = loo_Json.IntOf("data.access_token_expire_in")
ls_Refresh_token = loo_Json.StringOf("data.refresh_token")
li_Refresh_token_expire_in = loo_Json.IntOf("data.refresh_token_expire_in")
ls_Open_id = loo_Json.StringOf("data.open_id")
ls_Seller_name = loo_Json.StringOf("data.seller_name")
ls_Seller_base_region = loo_Json.StringOf("data.seller_base_region")
li_User_type = loo_Json.IntOf("data.user_type")
ls_Request_id = loo_Json.StringOf("request_id")
i = 0
li_Count_i = loo_Json.SizeOfArray("data.granted_scopes")
do while i < li_Count_i
    loo_Json.I = i
    ls_StrVal = loo_Json.StringOf("data.granted_scopes[i]")
    i = i + 1
loop

// Save the JSON to a file for future requests, if needed..
loo_Fac = create oleobject
li_rc = loo_Fac.ConnectToNewObject("Chilkat.FileAccess")

loo_Fac.WriteEntireTextFile("qa_data/tokens/tiktok-shops.json",loo_Json.Emit(),"utf-8",0)


destroy loo_Oauth2
destroy loo_Json
destroy loo_Fac