Xbase++

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. Xbase++

LOCAL nSuccess
LOCAL oOauth2
LOCAL cUrl
LOCAL nNumMsWaited
LOCAL oJson
LOCAL cStrVal
LOCAL nCode
LOCAL cMessage
LOCAL cAccess_token
LOCAL nAccess_token_expire_in
LOCAL cRefresh_token
LOCAL nRefresh_token_expire_in
LOCAL cOpen_id
LOCAL cSeller_name
LOCAL cSeller_base_region
LOCAL nUser_type
LOCAL cRequest_id
LOCAL i
LOCAL nCount_i
LOCAL oFac

nSuccess := 0

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

oOauth2 := CreateObject("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.
cUrl := oOauth2:StartAuth()
IF (oOauth2:LastMethodSuccess == 0)
    ? oOauth2:LastErrorText
    oOauth2:destroy()
    RETURN
ENDIF

//  Launch the system's default browser navigated to the URL.
nSuccess := oOauth2:LaunchBrowser(cUrl)
IF (nSuccess == 0)
    ? oOauth2:LastErrorText
    oOauth2:destroy()
    RETURN
ENDIF

//  Now wait for the authorization.
//  We'll wait for a max of 60 seconds.
nNumMsWaited := 0
DO WHILE (nNumMsWaited < 60000) .AND. (oOauth2:AuthFlowState < 3)
    oOauth2:SleepMs(100)
    nNumMsWaited := nNumMsWaited + 100
ENDDO

//  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)
    oOauth2:Cancel()
    ? "No response from the browser!"
    oOauth2:destroy()
    RETURN
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)
    ? "OAuth2 failed to complete."
    ? oOauth2:FailureInfo
    oOauth2:destroy()
    RETURN
ENDIF

IF (oOauth2:AuthFlowState == 4)
    ? "OAuth2 authorization was denied."
    ? oOauth2:AccessTokenResponse
    oOauth2:destroy()
    RETURN
ENDIF

IF (oOauth2:AuthFlowState != 3)
    ? "Unexpected AuthFlowState:" + Str(oOauth2:AuthFlowState)
    oOauth2:destroy()
    RETURN
ENDIF

? "OAuth2 authorization granted!"
? "Access Token = " + oOauth2:AccessToken

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

? oJson:Emit()

//  How to get values from the JSON:

nCode := oJson:IntOf("code")
cMessage := oJson:StringOf("message")
cAccess_token := oJson:StringOf("data.access_token")
nAccess_token_expire_in := oJson:IntOf("data.access_token_expire_in")
cRefresh_token := oJson:StringOf("data.refresh_token")
nRefresh_token_expire_in := oJson:IntOf("data.refresh_token_expire_in")
cOpen_id := oJson:StringOf("data.open_id")
cSeller_name := oJson:StringOf("data.seller_name")
cSeller_base_region := oJson:StringOf("data.seller_base_region")
nUser_type := oJson:IntOf("data.user_type")
cRequest_id := oJson:StringOf("request_id")
i := 0
nCount_i := oJson:SizeOfArray("data.granted_scopes")
DO WHILE i < nCount_i
    oJson:I := i
    cStrVal := oJson:StringOf("data.granted_scopes[i]")
    i := i + 1
ENDDO

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

oOauth2:destroy()
oJson:destroy()
oFac:destroy()