Rust

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

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

let oauth2 = chilkat::OAuth2::new();

// 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.set_listen_port(3017);

oauth2.set_authorization_endpoint("https://services.tiktokshop.com/open/authorize");
oauth2.set_token_endpoint("https://auth.tiktok-shops.com/api/v2/token/get");

// Replace these with actual values.
oauth2.set_client_id("APP_KEY");
oauth2.set_client_secret("APP_SECRET");

oauth2.set_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.
let _ = oauth2.add_auth_query_param("service_id", "YOUR_SERVICE_ID");

// Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
let Ok(url) = oauth2.start_auth() else {
    println!("{}", oauth2.last_error_text());
    return;
};

// Launch the system's default browser navigated to the URL.
if oauth2.launch_browser(&url).is_err() {
    println!("{}", oauth2.last_error_text());
    return;
}

// Now wait for the authorization.
// We'll wait for a max of 60 seconds.
let mut num_ms_waited = 0;
while (num_ms_waited < 60000) && (oauth2.auth_flow_state() < 3) {
    oauth2.sleep_ms(100);
    num_ms_waited = num_ms_waited + 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.auth_flow_state() < 3 {
    let _ = oauth2.cancel();
    println!("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.auth_flow_state() == 5 {
    println!("OAuth2 failed to complete.");
    println!("{}", oauth2.failure_info());
    return;
}

if oauth2.auth_flow_state() == 4 {
    println!("OAuth2 authorization was denied.");
    println!("{}", oauth2.access_token_response());
    return;
}

if oauth2.auth_flow_state() != 3 {
    println!("Unexpected AuthFlowState:{}", oauth2.auth_flow_state());
    return;
}

println!("OAuth2 authorization granted!");
println!("Access Token = {}", oauth2.access_token());

// Get the full JSON response:
let json = chilkat::JsonObject::new();
let _ = json.load(&oauth2.access_token_response());
json.set_emit_compact(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......"
// }

println!("{}", json.emit().unwrap_or_default());

// How to get values from the JSON:

let code = json.int_of("code");
let message = json.string_of("message").unwrap_or_default();
let access_token = json.string_of("data.access_token").unwrap_or_default();
let access_token_expire_in = json.int_of("data.access_token_expire_in");
let refresh_token = json.string_of("data.refresh_token").unwrap_or_default();
let refresh_token_expire_in = json.int_of("data.refresh_token_expire_in");
let open_id = json.string_of("data.open_id").unwrap_or_default();
let seller_name = json.string_of("data.seller_name").unwrap_or_default();
let seller_base_region = json.string_of("data.seller_base_region").unwrap_or_default();
let user_type = json.int_of("data.user_type");
let request_id = json.string_of("request_id").unwrap_or_default();
let mut i = 0;
let count_i = json.size_of_array("data.granted_scopes");
while i < count_i {
    json.set_i(i);
    let _ = json.string_of("data.granted_scopes[i]").unwrap_or_default();
    i = i + 1;
}

// Save the JSON to a file for future requests, if needed..
let fac = chilkat::FileAccess::new();
let _ = fac.write_entire_text_file("qa_data/tokens/tiktok-shops.json", &json.emit().unwrap_or_default(), "utf-8", false);