SHOPLINE Function 快速入门

你可以通过此文档进行函数开发的快速入门。

前提条件

创建你的应用

你可以根据 SHOPLINE 应用的分发方式,按照你所需要的场景去 创建应用

准备本地开发环境

操作系统:macOS

TinyGo:0.27.0

Go:1.20.2

SHOPLINE CLI:@shoplinedevshoplinedev/cli@1.9.18 以上

申请公测权限

联系 openapi_v2@shopline.com 开通白名单,需提供的信息如下:

  • App key:应用的唯一标识,在 合作伙伴后台 获取。

  • 使用场景描述。

集成步骤

步骤一:登录开发商店

在 SHOPLINE CLI登录开发商店,你可以使用 --store 参数来指定商店名。

shopline login --store <STORE_DOMAIN>

步骤二:下载模版

创建本地函数模版,你可以使用 --name 参数来指定你的函数名称,下载路径为当前命令执行路径。

shopline extension create --name <FUNCTION_NAME>

步骤三:开发函数

函数入口为 main.go ,开始开发你的函数逻辑。

示例:

func PaymentCustomizationFunction(req *module.PaymentCustomizationFunctionRequest) (result module.PaymentCustomizationFunctionResponse) {
	//hello function
	return module.PaymentCustomizationFunctionResponse{}
}

步骤四:配置函数路由

shopline.function.extension.toml 配置函数规则页面路由, create 对应函数规则创建页面, details 对应函数规则详情页面。

示例:

[ui.paths]
create = "/payment-customization/:functionId/new"
details = "/payment-customization/:functionId/:id"

步骤五:发布函数至开发商店

发布函数至开发商店。

shopline extension push

步骤六:验证函数

根据场景验证函数逻辑。例如:在开发商店配置函数元数据后,再验证函数逻辑。

步骤七:发布函数至应用

  1. 前往合作伙伴后台,进入你的团队。

  2. 选中你的应用,进入应用扩展,查看已有的函数扩展。

  1. 进入版本管理。

  2. 创建版本,查看该版本下已有的扩展列表,确定后点击创建并提交审核。

  3. 审核通过后,进行发布。