(JavaScript) TikTok Shop OAuth2

See more TikTok Shop Examples

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

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

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

var oauth2 = new CkOAuth2();

// 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 == false) {
    console.log(oauth2.LastErrorText);
    return;
}

// Launch the system's default browser navigated to the URL.
success = oauth2.LaunchBrowser(url);
if (success == false) {
    console.log(oauth2.LastErrorText);
    return;
}

// 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 CkJsonObject();
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 CkFileAccess();
fac.WriteEntireTextFile("qa_data/tokens/tiktok-shops.json",json.Emit(),"utf-8",false);