(Node.js) 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.

IMPORTANT: This example requires a pre-release for the next version of Chilkat after the current v9.5.0.99 release. Contact info@chilkatsoft.com if you wish to get a pre-release. However, pre-releases of .NET Core (hosted on NuGet) and Node.js will not be possible.

For more information, see https://partner.tiktokshop.com/doc/page/63fd743c715d622a338c4e54

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

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

    var oauth2 = new chilkat.OAuth2();
    var success;

    // 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("service_id","YOUR_SERVICE_ID");

    // Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
    var url = oauth2.StartAuth();
    if (oauth2.LastMethodSuccess !== true) {
        console.log(oauth2.LastErrorText);
        return;
    }

    // -------------------------------------------------------------------
    // IMPORTANT:
    // At this point, your application should load the URL in a browser.
    // For example, 
    // in C#: System.Diagnostics.Process.Start(url);
    // in Java: Desktop.getDesktop().browse(new URI(url));
    // in VBScript: Set wsh=WScript.CreateObject("WScript.Shell")
    //              wsh.Run url
    // in Xojo: ShowURL(url)  (see http://docs.xojo.com/index.php/ShowURL)
    // in Dataflex: Runprogram Background "c:\Program Files\Internet Explorer\iexplore.exe" sUrl
    // in C++ on Windows: ShellExecute(0, 0, url, 0, 0 , SW_SHOW );

    // Add the code to load the url in a web browser here...
    // Add the code to load the url in a web browser here...
    // Add the code to load the url in a web browser here...

    // Now wait for the authorization.
    // We'll wait for a max of 60 seconds.
    var numMsWaited = 0;
    while ((numMsWaited < 60000) && (oauth2.AuthFlowState < 3)) {
        oauth2.SleepMs(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 < 3) {
        oauth2.Cancel();
        console.log("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 == 5) {
        console.log("OAuth2 failed to complete.");
        console.log(oauth2.FailureInfo);
        return;
    }

    if (oauth2.AuthFlowState == 4) {
        console.log("OAuth2 authorization was denied.");
        console.log(oauth2.AccessTokenResponse);
        return;
    }

    if (oauth2.AuthFlowState !== 3) {
        console.log("Unexpected AuthFlowState:" + oauth2.AuthFlowState);
        return;
    }

    console.log("OAuth2 authorization granted!");
    console.log("Access Token = " + oauth2.AccessToken);

    // Get the full JSON response:
    var json = new chilkat.JsonObject();
    json.Load(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......"
    // }

    console.log(json.Emit());

    // How to get values from the JSON:
    var strVal;

    var code = json.IntOf("code");
    var message = json.StringOf("message");
    var Access_token = json.StringOf("data.access_token");
    var Access_token_expire_in = json.IntOf("data.access_token_expire_in");
    var Refresh_token = json.StringOf("data.refresh_token");
    var Refresh_token_expire_in = json.IntOf("data.refresh_token_expire_in");
    var Open_id = json.StringOf("data.open_id");
    var Seller_name = json.StringOf("data.seller_name");
    var Seller_base_region = json.StringOf("data.seller_base_region");
    var User_type = json.IntOf("data.user_type");
    var request_id = json.StringOf("request_id");
    var i = 0;
    var count_i = json.SizeOfArray("data.granted_scopes");
    while (i < count_i) {
        json.I = i;
        strVal = json.StringOf("data.granted_scopes[i]");
        i = i+1;
    }

    // Save the JSON to a file for future requests, if needed..
    var fac = new chilkat.FileAccess();
    fac.WriteEntireTextFile("qa_data/tokens/tiktok-shops.json",json.Emit(),"utf-8",false);

}

chilkatExample();