TikTok Shop API PHP客户端使用指南
【免费下载链接】tiktokshop-php Unofficial Tiktok Shop API Client in PHP. Use API version 202309 and later 项目地址: https://gitcode.***/gh_mirrors/ti/tiktokshop-php
项目介绍
TikTok Shop API Client是一个简单的SDK实现,用于访问TikTok商店API。该库支持API版本202309及以后的版本。对于那些寻求接入旧版API(发布于2023年9月前)的开发者,项目维护者推荐使用v1.x版本。此客户端简化了在PHP项目中集成TikTok商店功能的过程,使得开发者能够更容易地进行商品管理、订单处理等操作。
环境要求
- PHP 7.2或更高版本
- JSON扩展
- Guzzle HTTP客户端
安装配置
通过***poser安装
***poser require e***php/tiktokshop-php
配置TikTokShop PHP客户端
use E***PHP\TiktokShop\Client;
$app_key = 'your app key';
$app_secret = 'your app secret';
$client = new Client($app_key, $app_secret);
授权流程
获取访问令牌
使用OAuth流程获取店铺的访问令牌:
$auth = $client->auth();
$_SESSION['state'] = $state = str_random(40); // 生成随机状态码
$authUrl = $auth->createAuthRequest($state, true);
// 重定向用户到授权页面
header('Location: ' . $authUrl);
用户授权后,从回调URL中获取认证码并兑换成令牌:
$authorization_code = $_GET['code'];
$token = $auth->getToken($authorization_code);
$a***ess_token = $token['a***ess_token'];
$refresh_token = $token['refresh_token'];
获取授权店铺信息
$client->setA***essToken($a***ess_token);
$authorizedShopList = $client->Authorization->getAuthorizedShop();
// 从$authorizedShopList中提取shop_id和cipher供后续使用
刷新访问令牌
访问令牌会很快过期,需要使用refresh_token刷新新令牌:
$new_token = $auth->refreshNewToken($refresh_token);
$new_a***ess_token = $new_token['a***ess_token'];
$new_refresh_token = $new_token['refresh_token'];
API使用示例
初始化客户端
$client = new Client($app_key, $app_secret);
$client->setA***essToken($a***ess_token);
$client->setShopCipher($shop_cipher);
获取商品列表
$products = $client->Product->getProductList([
'page_size' => 50,
]);
获取订单列表
$orders = $client->Order->getOrderList([
'order_status' => 100, // 未支付订单
'page_size' => 50,
]);
切换API版本
默认使用API版本202309,可以通过以下方式切换版本:
$products = $client->Product->useVersion('202312')->checkListingPrerequisites();
Webhook集成
使用webhook接收来自TikTok商店的通知:
$webhook = $client->webhook();
或者手动配置webhook接收器:
use E***PHP\TiktokShop\Webhook;
use E***PHP\TiktokShop\Errors\TiktokShopException;
$webhook = new Webhook($client);
try {
$webhook->verify();
$webhook->capture($_POST);
} catch (TiktokShopException $e) {
echo "webhook error: " . $e->getMessage() . "\n";
}
处理webhook数据:
echo "Type: " . $webhook->getType() . "\n";
echo "Timestamp: " . $webhook->getTimestamp() . "\n";
echo "Shop ID: " . $webhook->getShopId() . "\n";
echo "Data: \n"; // data是数组
print_r($webhook->getData());
项目结构
该项目采用清晰的目录结构组织代码:
-
src/- 核心源代码目录 -
src/Errors/- 异常处理类 -
src/Resources/- API资源类(商品、订单、支付等) -
tests/- 单元测试目录
应用场景
电商集成
该SDK可以用于将TikTok商店集成到现有的电商平台中,实现商品同步、订单管理和库存更新等功能。
营销自动化
通过API可以自动化营销活动,如创建促销活动、管理优惠券和跟踪营销效果。
数据分析
利用Analytics API获取销售数据、用户行为分析等,为业务决策提供数据支持。
最佳实践
- 安全存储:确保所有敏感信息(如token、API密钥)安全存储
- 异常处理:对所有API调用实施异常处理,保证应用的健壮性
- 令牌管理:定期刷新访问令牌,避免因令牌过期导致的服务中断
- 错误日志:记录详细的错误日志,便于排查问题
- 版本控制:关注API版本更新,及时适配新版本
通过集成TikTok Shop API,开发者可以将TikTok作为一个销售渠道扩展到他们的现有电商平台中,实现商品同步、订单管理和营销活动的自动化。
技术支持
如果在使用过程中遇到问题,可以参考项目中的测试用例或查看相关的API文档。建议在正式环境使用前,先在沙箱环境中进行充分测试。
【免费下载链接】tiktokshop-php Unofficial Tiktok Shop API Client in PHP. Use API version 202309 and later 项目地址: https://gitcode.***/gh_mirrors/ti/tiktokshop-php