Stars: 116
Forks: 18
Pull Requests: 13
Issues: 4
Watchers: 4
Last Updated: 2023-08-04 18:29:03
Unofficial Tiktok Shop API Client in PHP
License: Apache License 2.0
Languages: PHP
Tiktok Shop API Client is a simple SDK implementation of Tiktok Shop API.
Install with Composer
composer require nvuln/tiktokshop-php
use NVuln\TiktokShop\Client;
$app_key = 'your app key';
$app_secret = 'your app secret';
$client = new Client($app_key, $app_secret);
$client->useSandboxMode();
There is a Auth class to help you getting the token from the shop using oAuth.
$auth = $client->auth();
$_SESSION['state'] = $state = str_random(40); // random string
$auth->createAuthRequest($state);
If you want the function to return the authentication url instead of auto-redirecting, you can set the argument $return (2nd argument) to true.
$authUrl = $auth->createAuthRequest($state, true);
// redirect user to auth url
header('Location: '.$authUrl);
Redirect callback URL
after app authorization and exchange it for access token$authorization_code = $_GET['code'];
$token = $auth->getToken($authorization_code);
$access_token = $token['access_token'];
$refresh_token = $token['refresh_token'];
$access_token = $token['access_token'];
$client->setAccessToken($access_token);
$authorizedShopList = $client->Shop->getAuthorizedShop();
// extract shop_id from $authorizedShopList
Access token will be expired soon, so you need refresh new token by using
refresh_token
$new_token = $auth->refreshNewToken($refresh_token);
$new_access_token = $new_token['access_token'];
$new_refresh_token = $new_token['refresh_token'];
You need
access_token
andshop_id
to start using TiktokShop API
$client = new Client($app_key, $app_secret);
$client->setAccessToken($access_token);
$client->setShopId($shop_id);
$products = $client->Product->getProductList([
'page_size' => 50,
]);
$orders = $client->Order->getOrderList([
'order_status' => 100, // Unpaid order
'page_size' => 50,
]);
Use webhook to receive incoming notification from tiktok shop
$webhook = $client->webhook();
or manually configure the webhook receiver
use NVuln\TiktokShop\Webhook;
use NVuln\TiktokShop\Errors\TiktokShopException;
$webhook = new Webhook($client);
try {
$webhook->verify();
$webhook->capture($_POST);
} catch (TiktokShopException $e) {
echo "webhook error: " . $e->getMessage() . "\n";
}
echo "Type: " . $webhook->getType() . "\n";
echo "Timestamp: " . $webhook->getTimestamp() . "\n";
echo "Shop ID: " . $webhook->getShopId() . "\n";
echo "Data: \n"; // data is array
print_r($webhook->getData());