Java SDK

tiktok-shop-api is a typed Java client for the TikTok Shop Partner API. It signs requests, handles OAuth, works with many shops at once, and verifies and types webhooks. It is published to Maven Central, and its source is in java/.

Install

Maven:

<dependency>
  <groupId>com.isaackogan</groupId>
  <artifactId>tiktok-shop-api</artifactId>
  <version>0.1.0</version>
</dependency>

Gradle:

implementation 'com.isaackogan:tiktok-shop-api:0.1.0'

Requires Java 11 or newer. The HTTP layer is OkHttp and the JSON layer is gson.

First call

With an access token from the OAuth helper, build a client and call an operation:

import com.isaackogan.tiktok.shop.TikTokShop;
import com.isaackogan.tiktok.shop.generated.ApiException;
import com.isaackogan.tiktok.shop.generated.model.GetAuthorizedShopsResponse;

class FirstCall {
    void run() throws ApiException {
        TikTokShop client = TikTokShop.builder()
                .appKey("YOUR_APP_KEY")
                .appSecret("YOUR_APP_SECRET")
                .accessToken("ACCESS_TOKEN")
                .build();

        GetAuthorizedShopsResponse shops = client.authorization().getAuthorizedShops();
        System.out.println(shops.getData().getShops().get(0).getCipher());
    }
}

Each API group is a getter on the client (orders(), products(), fulfillment(), finance(), …) returning the generated API class. Signing, app_key, timestamp, the x-tts-access-token header and shop_cipher are added for you.

In this section

• Authorization: TikTokShopAuth, authorization URLs, token exchange and refresh.
• Calling the API: the client, API groups, many shops and options.
• Webhooks: Webhooks.verifyAndParse and typed events.
• Errors: TikTokShopException, ApiException and their codes.