Swift

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

func chilkatTest() {
    var success: Bool = false

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

    let oauth2 = CkoOAuth2()!

    // 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.
    oauth2.listenPort = 3017

    oauth2.authorizationEndpoint = "https://services.tiktokshop.com/open/authorize"
    oauth2.tokenEndpoint = "https://auth.tiktok-shops.com/api/v2/token/get"

    // Replace these with actual values.
    oauth2.clientId = "APP_KEY"
    oauth2.clientSecret = "APP_SECRET"

    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.
    oauth2.addAuthQueryParam(name: "service_id", value: "YOUR_SERVICE_ID")

    // Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
    var url: String? = oauth2.startAuth()
    if oauth2.lastMethodSuccess == false {
        print("\(oauth2.lastErrorText!)")
        return
    }

    // Launch the system's default browser navigated to the URL.
    success = oauth2.launchBrowser(url: url)
    if success == false {
        print("\(oauth2.lastErrorText!)")
        return
    }

    // Now wait for the authorization.
    // We'll wait for a max of 60 seconds.
    var numMsWaited: Int = 0
    while (numMsWaited < 60000) && (oauth2.authFlowState.intValue < 3) {
        oauth2.sleepMs(millisec: 100)
        numMsWaited = numMsWaited + 100
    }

    // 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 oauth2.authFlowState.intValue < 3 {
        oauth2.cancel()
        print("No response from the browser!")
        return
    }

    // 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 oauth2.authFlowState.intValue == 5 {
        print("OAuth2 failed to complete.")
        print("\(oauth2.failureInfo!)")
        return
    }

    if oauth2.authFlowState.intValue == 4 {
        print("OAuth2 authorization was denied.")
        print("\(oauth2.accessTokenResponse!)")
        return
    }

    if oauth2.authFlowState.intValue != 3 {
        print("Unexpected AuthFlowState:\(oauth2.authFlowState.intValue)")
        return
    }

    print("OAuth2 authorization granted!")
    print("Access Token = \(oauth2.accessToken!)")

    // Get the full JSON response:
    let json = CkoJsonObject()!
    json.load(json: oauth2.accessTokenResponse)
    json.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......"
    // }

    print("\(json.emit()!)")

    // How to get values from the JSON:
    var strVal: String?

    var code: Int = json.int(of: "code").intValue
    var message: String? = json.string(of: "message")
    var Access_token: String? = json.string(of: "data.access_token")
    var Access_token_expire_in: Int = json.int(of: "data.access_token_expire_in").intValue
    var Refresh_token: String? = json.string(of: "data.refresh_token")
    var Refresh_token_expire_in: Int = json.int(of: "data.refresh_token_expire_in").intValue
    var Open_id: String? = json.string(of: "data.open_id")
    var Seller_name: String? = json.string(of: "data.seller_name")
    var Seller_base_region: String? = json.string(of: "data.seller_base_region")
    var User_type: Int = json.int(of: "data.user_type").intValue
    var request_id: String? = json.string(of: "request_id")
    var i: Int = 0
    var count_i: Int = json.size(ofArray: "data.granted_scopes").intValue
    while i < count_i {
        json.i = i
        strVal = json.string(of: "data.granted_scopes[i]")
        i = i + 1
    }

    // Save the JSON to a file for future requests, if needed..
    let fac = CkoFileAccess()!
    fac.writeEntireTextFile(path: "qa_data/tokens/tiktok-shops.json", fileData: json.emit(), charset: "utf-8", includePreamble: false)

}