Visual FoxPro

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. Visual FoxPro

LOCAL lnSuccess
LOCAL loOauth2
LOCAL lcUrl
LOCAL lnNumMsWaited
LOCAL loJson
LOCAL lcStrVal
LOCAL lnCode
LOCAL lcMessage
LOCAL lcAccess_token
LOCAL lnAccess_token_expire_in
LOCAL lcRefresh_token
LOCAL lnRefresh_token_expire_in
LOCAL lcOpen_id
LOCAL lcSeller_name
LOCAL lcSeller_base_region
LOCAL lnUser_type
LOCAL lcRequest_id
LOCAL i
LOCAL lnCount_i
LOCAL loFac

lnSuccess = 0

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

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

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

* Replace these with actual values.
loOauth2.ClientId = "APP_KEY"
loOauth2.ClientSecret = "APP_SECRET"

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

* Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
lcUrl = loOauth2.StartAuth()
IF (loOauth2.LastMethodSuccess = 0) THEN
    ? loOauth2.LastErrorText
    RELEASE loOauth2
    CANCEL
ENDIF

* Launch the system's default browser navigated to the URL.
lnSuccess = loOauth2.LaunchBrowser(lcUrl)
IF (lnSuccess = 0) THEN
    ? loOauth2.LastErrorText
    RELEASE loOauth2
    CANCEL
ENDIF

* Now wait for the authorization.
* We'll wait for a max of 60 seconds.
lnNumMsWaited = 0
DO WHILE (lnNumMsWaited < 60000) AND (loOauth2.AuthFlowState < 3)
    loOauth2.SleepMs(100)
    lnNumMsWaited = lnNumMsWaited + 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 (loOauth2.AuthFlowState < 3) THEN
    loOauth2.Cancel()
    ? "No response from the browser!"
    RELEASE loOauth2
    CANCEL
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 (loOauth2.AuthFlowState = 5) THEN
    ? "OAuth2 failed to complete."
    ? loOauth2.FailureInfo
    RELEASE loOauth2
    CANCEL
ENDIF

IF (loOauth2.AuthFlowState = 4) THEN
    ? "OAuth2 authorization was denied."
    ? loOauth2.AccessTokenResponse
    RELEASE loOauth2
    CANCEL
ENDIF

IF (loOauth2.AuthFlowState <> 3) THEN
    ? "Unexpected AuthFlowState:" + STR(loOauth2.AuthFlowState)
    RELEASE loOauth2
    CANCEL
ENDIF

? "OAuth2 authorization granted!"
? "Access Token = " + loOauth2.AccessToken

* Get the full JSON response:
loJson = CreateObject('Chilkat.JsonObject')
loJson.Load(loOauth2.AccessTokenResponse)
loJson.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......"
* }

? loJson.Emit()

* How to get values from the JSON:

lnCode = loJson.IntOf("code")
lcMessage = loJson.StringOf("message")
lcAccess_token = loJson.StringOf("data.access_token")
lnAccess_token_expire_in = loJson.IntOf("data.access_token_expire_in")
lcRefresh_token = loJson.StringOf("data.refresh_token")
lnRefresh_token_expire_in = loJson.IntOf("data.refresh_token_expire_in")
lcOpen_id = loJson.StringOf("data.open_id")
lcSeller_name = loJson.StringOf("data.seller_name")
lcSeller_base_region = loJson.StringOf("data.seller_base_region")
lnUser_type = loJson.IntOf("data.user_type")
lcRequest_id = loJson.StringOf("request_id")
i = 0
lnCount_i = loJson.SizeOfArray("data.granted_scopes")
DO WHILE i < lnCount_i
    loJson.I = i
    lcStrVal = loJson.StringOf("data.granted_scopes[i]")
    i = i + 1
ENDDO

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

RELEASE loOauth2
RELEASE loJson
RELEASE loFac