welford-media/craft-tik-tok-for-commerce

为Craft Commerce提供TikTok商店的集成。

dev-master 2024-08-15 15:46 UTC

This package is auto-updated.

Last update: 2024-09-15 16:04:19 UTC


README

为Craft Commerce中的TikTok商店提供产品同步和订单同步。

要求

此插件需要Craft CMS 4.11.0或更高版本、Craft Commerce和PHP 8.0.2或更高版本。

此插件还需要Craft Commerce中的特定配置选项

  • 重量单位 - 必须设置为千克。
  • 尺寸单位 - 必须设置为厘米。
  • 产品类型 - 必须设置为显示并使用尺寸和重量字段。
  • 多变体产品 - 必须设置为显示并使用尺寸和重量字段。
  • 产品不能设置为无限库存。

安装

您可以从插件商店或使用Composer安装此插件。

从插件商店

转到您的项目控制面板中的插件商店,搜索“TikTok for Commerce”,然后点击“安装”。

使用Composer

打开您的终端,并运行以下命令

# go to the project directory
cd /path/to/my-project.test

# tell Composer to load the plugin
composer require welford-media/craft-tik-tok-for-commerce

# tell Craft to install the plugin
./craft plugin/install tik-tok-for-commerce

用法

产品同步

首先,您需要设置一个TikTok合作伙伴账户和私有开发者应用程序。有关如何操作的更多信息,请参阅TikTok文档

在创建您的TikTok应用程序时,您必须使用以下选项进行配置

  • 应用名称:可以是您喜欢的任何名称。
  • 重定向URL:这应该是您的Craft CMS站点URL,后跟/admin/tiktok-callback。例如,https://example.com/admin/tiktok-callback。如果您的控制面板触发器不同,您应相应地调整此设置。
  • Webhook URL:这应该是您的Craft CMS站点URL,后跟/tiktok-webhook。例如,https://example.com/tiktok-webhook

创建后,您将能够复制您的应用程序密钥和应用程序密钥。在配置插件时,您将需要这些值。

需要一些额外的设置,以便插件可以访问您的商店信息。点击“基本信息”旁边的“管理API”按钮,并启用以下包

  • 全球商店信息
  • 物流基础
  • 订单信息
  • 产品基础
  • 产品删除与恢复
  • 产品修改
  • 商店授权信息

如果不启用这些包,您将遇到错误,并且插件将无法正确运行。请确保它们正确设置。

现在您可以通过转到插件设置页面并输入在创建TikTok应用程序时收到的应用程序密钥和应用程序密钥来配置插件。保存设置后,点击“连接TikTok”并按照网站上的说明授权插件连接到您的TikTok商店。

如果一切顺利,您将收到一条成功消息,并且插件将有权连接到您的TikTok商店。

现在从插件设置页面选择您要连接的商店并按保存。

完成以上步骤后,您现在可以配置产品以与您的TikTok商店同步。

要启用产品或特定变体与TikTok同步,您必须

  • 创建一个新的资产字段,名称为tiktokImage。该字段只允许选择一张图片,并确保类型设置为仅图片。 目前TikTok只支持JPG和PNG图片。 将此字段应用到您的产品或变体字段。
  • 使用自定义字段类型TikTok Fields创建一个新的字段。您可以按自己的意愿命名此字段。此字段提供了插件与TikTok同步产品所需的功能。将此字段应用到您的产品或变体字段。

现在您的字段已设置完成,检查您的产品及变体,确保TikTok Fields选项中填充了正确的信息。保存每个产品后,它将自动同步到您的TikTok商店。

订单同步

在TikTok上创建的订单可以通过webhook自动发送到Craft Commerce。要启用此功能,您需要

  • 创建您的TikTok应用程序,并已提供如上所述的webhook URL。
  • 使用插件提供的自定义字段类型TikTok Order ID创建一个新的字段。此字段允许插件将Craft Commerce订单与正确的TikTok订单链接起来。将此字段应用到您的订单字段设置中的订单字段。

TikTok提供了多种订单状态。这些状态将在Craft Commerce中按以下方式处理

  • 未支付 - 这些订单同步到Craft Commerce,作为用户在网站上浏览并添加商品到购物车但尚未结账的开放订单。
  • 等待发货、等待取货、在途中、已发货、已完成 - 这些订单同步到Craft Commerce,并将isPaid和isCompleted标志设置为true。

插件只会存储已从Craft Commerce同步的产品订单。如果收到未从Craft Commerce同步的产品的订单,将忽略该订单。