PureBasic

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

IncludeFile "CkFileAccess.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkOAuth2.pb"

Procedure ChilkatExample()

    success.i = 0

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

    oauth2.i = CkOAuth2::ckCreate()
    If oauth2.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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::setCkListenPort(oauth2, 3017)

    CkOAuth2::setCkAuthorizationEndpoint(oauth2, "https://services.tiktokshop.com/open/authorize")
    CkOAuth2::setCkTokenEndpoint(oauth2, "https://auth.tiktok-shops.com/api/v2/token/get")

    ; Replace these with actual values.
    CkOAuth2::setCkClientId(oauth2, "APP_KEY")
    CkOAuth2::setCkClientSecret(oauth2, "APP_SECRET")

    CkOAuth2::setCkScope(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::ckAddAuthQueryParam(oauth2,"service_id","YOUR_SERVICE_ID")

    ; Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
    url.s = CkOAuth2::ckStartAuth(oauth2)
    If CkOAuth2::ckLastMethodSuccess(oauth2) = 0
        Debug CkOAuth2::ckLastErrorText(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    ; Launch the system's default browser navigated to the URL.
    success = CkOAuth2::ckLaunchBrowser(oauth2,url)
    If success = 0
        Debug CkOAuth2::ckLastErrorText(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    ; Now wait for the authorization.
    ; We'll wait for a max of 60 seconds.
    numMsWaited.i = 0
    While (numMsWaited < 60000) AND (CkOAuth2::ckAuthFlowState(oauth2) < 3)
        CkOAuth2::ckSleepMs(oauth2,100)
        numMsWaited = numMsWaited + 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 CkOAuth2::ckAuthFlowState(oauth2) < 3
        CkOAuth2::ckCancel(oauth2)
        Debug "No response from the browser!"
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    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 CkOAuth2::ckAuthFlowState(oauth2) = 5
        Debug "OAuth2 failed to complete."
        Debug CkOAuth2::ckFailureInfo(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    If CkOAuth2::ckAuthFlowState(oauth2) = 4
        Debug "OAuth2 authorization was denied."
        Debug CkOAuth2::ckAccessTokenResponse(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    If CkOAuth2::ckAuthFlowState(oauth2) <> 3
        Debug "Unexpected AuthFlowState:" + Str(CkOAuth2::ckAuthFlowState(oauth2))
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    Debug "OAuth2 authorization granted!"
    Debug "Access Token = " + CkOAuth2::ckAccessToken(oauth2)

    ; Get the full JSON response:
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoad(json,CkOAuth2::ckAccessTokenResponse(oauth2))
    CkJsonObject::setCkEmitCompact(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......"
    ; }

    Debug CkJsonObject::ckEmit(json)

    ; How to get values from the JSON:
    strVal.s

    code.i = CkJsonObject::ckIntOf(json,"code")
    message.s = CkJsonObject::ckStringOf(json,"message")
    Access_token.s = CkJsonObject::ckStringOf(json,"data.access_token")
    Access_token_expire_in.i = CkJsonObject::ckIntOf(json,"data.access_token_expire_in")
    Refresh_token.s = CkJsonObject::ckStringOf(json,"data.refresh_token")
    Refresh_token_expire_in.i = CkJsonObject::ckIntOf(json,"data.refresh_token_expire_in")
    Open_id.s = CkJsonObject::ckStringOf(json,"data.open_id")
    Seller_name.s = CkJsonObject::ckStringOf(json,"data.seller_name")
    Seller_base_region.s = CkJsonObject::ckStringOf(json,"data.seller_base_region")
    User_type.i = CkJsonObject::ckIntOf(json,"data.user_type")
    request_id.s = CkJsonObject::ckStringOf(json,"request_id")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(json,"data.granted_scopes")
    While i < count_i
        CkJsonObject::setCkI(json, i)
        strVal = CkJsonObject::ckStringOf(json,"data.granted_scopes[i]")
        i = i + 1
    Wend

    ; Save the JSON to a file for future requests, if needed..
    fac.i = CkFileAccess::ckCreate()
    If fac.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkFileAccess::ckWriteEntireTextFile(fac,"qa_data/tokens/tiktok-shops.json",CkJsonObject::ckEmit(json),"utf-8",0)


    CkOAuth2::ckDispose(oauth2)
    CkJsonObject::ckDispose(json)
    CkFileAccess::ckDispose(fac)


    ProcedureReturn
EndProcedure