Zig

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

const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

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

    const oauth2 = try chilkat.OAuth2.init();
    defer oauth2.deinit();

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

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

    // Replace these with actual values.
    oauth2.setClientId("APP_KEY");
    oauth2.setClientSecret("APP_SECRET");

    oauth2.setScope("");

    // 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") catch {};

    // Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
    const url = oauth2.startAuth(alloc) catch {
        std.debug.print("{s}\n", .{try oauth2.getLastErrorText(alloc)});
        return;
    };

    // Launch the system's default browser navigated to the URL.
    oauth2.launchBrowser(url) catch {
        std.debug.print("{s}\n", .{try oauth2.getLastErrorText(alloc)});
        return;
    };

    // Now wait for the authorization.
    // We'll wait for a max of 60 seconds.
    var num_ms_waited: i32 = 0;
    while ((num_ms_waited < 60000) and (oauth2.getAuthFlowState() < 3)) {
        oauth2.sleepMs(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.getAuthFlowState() < 3) {
        oauth2.cancel() catch {};
        std.debug.print("No response from the browser!\n", .{});
        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.getAuthFlowState() == 5) {
        std.debug.print("OAuth2 failed to complete.\n", .{});
        std.debug.print("{s}\n", .{try oauth2.getFailureInfo(alloc)});
        return;
    }

    if (oauth2.getAuthFlowState() == 4) {
        std.debug.print("OAuth2 authorization was denied.\n", .{});
        std.debug.print("{s}\n", .{try oauth2.getAccessTokenResponse(alloc)});
        return;
    }

    if (oauth2.getAuthFlowState() != 3) {
        std.debug.print("Unexpected AuthFlowState:{d}\n", .{oauth2.getAuthFlowState()});
        return;
    }

    std.debug.print("OAuth2 authorization granted!\n", .{});
    std.debug.print("Access Token = {s}\n", .{try oauth2.getAccessToken(alloc)});

    // Get the full JSON response:
    const json = try chilkat.JsonObject.init();
    defer json.deinit();
    json.load(try oauth2.getAccessTokenResponse(alloc)) catch {};
    json.setEmitCompact(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......"
    // }

    std.debug.print("{s}\n", .{try json.emit(alloc)});

    // How to get values from the JSON:
    var str_val: [:0]const u8 = "";

    _ = json.intOf("code");
    _ = try json.stringOf(alloc, "message");
    _ = try json.stringOf(alloc, "data.access_token");
    _ = json.intOf("data.access_token_expire_in");
    _ = try json.stringOf(alloc, "data.refresh_token");
    _ = json.intOf("data.refresh_token_expire_in");
    _ = try json.stringOf(alloc, "data.open_id");
    _ = try json.stringOf(alloc, "data.seller_name");
    _ = try json.stringOf(alloc, "data.seller_base_region");
    _ = json.intOf("data.user_type");
    _ = try json.stringOf(alloc, "request_id");
    var i: i32 = 0;
    const count_i = json.sizeOfArray("data.granted_scopes");
    while (i < count_i) {
        json.setI(i);
        str_val = try json.stringOf(alloc, "data.granted_scopes[i]");
        i = i + 1;
    }

    // Save the JSON to a file for future requests, if needed..
    const fac = try chilkat.FileAccess.init();
    defer fac.deinit();
    fac.writeEntireTextFile("qa_data/tokens/tiktok-shops.json", try json.emit(alloc), "utf-8", false) catch {};
}