小程序快速接入#

小程序快速接入#

1. 小程序概述#

闲鱼小程序是可以在闲鱼App内运行的小程序。该小程序可以理解为能力增强,并且受到闲鱼平台管控的H5

注意:闲鱼小程序目前不对外公开开放申请,只面向闲鱼运营小二定向邀请的服务商,未经邀请的注册将不予通过。

2. 创建小程序#

2.1 创建淘宝企业账号#

这个账号是用来申请top平台的appKey的,后面开发小程序、调用top接口都需要用到这个appKey。

打开淘宝企业账号注册,使用签约企业账号完成注册,这里需要同步创建支付宝账号,并完成支付宝实名认证。

使用注册的企业账号登陆淘宝开放平台,完成实名认证,并且选择入驻身份。

注意:淘宝开放平台入驻主体 、闲鱼入驻主体、合同签约主体,这三者需要一致

2.2 入驻开放平台#

2.2.0 业务身份申请确认#

1、淘宝开放平台,选择开发创建应用,选择 阿里生态API开发 (如果没有这个选项,看第2步操作流程。如果已有该选项直接进行后续的appKey申请)

2、https://work.open.taobao.com/open-console-enter 入驻 应用软件开发商,会出现 阿里生态API开发 业务分类(如果已有其他业务身份导致不能申请应用软件开发商,先查看是否已经有 阿里生态API开发 分类,已有该分类则跳过此步,没有则查看是否有闲鱼开发者业务,入驻此业务身份)

2.2.1 小程序 AppKey 申请#

创建应用 -> 选择 阿里生态API开发。(如果没有这个分类,请联系闲鱼技术同学)

选择 闲鱼垂直行业-C端 确认类目。

确认类目 -> 填写信息 -> 发起审批。

MRD和PRD可以上传对接的业务需求背景文档,其他三项可以先随便mock一下。

2.2.2 商家端 AppKey 申请#

注意:需要使用订单能力一定要申请这项,不使用订单则跳过这一步

创建应用 -> 选择 阿里生态API开发。(如果没有这个分类,请联系闲鱼技术同学)

2.选择 闲鱼垂直行业-B端 确认类目。

和小程序appKey一样,提交信息发起审批。

2.2.3 创建对应类目的应用#

发起审批后,同步运营老师,让运营老师去推进审批流程。

审批通过后,回到淘宝开发平台,找到对应审批记录。

进入开发,创建对应类目下的应用。

2.2.4 闲鱼开放平台申请注册#

打开闲鱼三方开放平台,首次进入需要登录,这里使用闲鱼账号登陆即可。

登录闲鱼三方开放平台后,点击右上角「+申请注册」按钮。如下图所示,填写相关信息。

注意:请使用签约企业所有的闲鱼账号,切勿使用个人闲鱼账号,因为后续小程序相关的发布上线等操作都需要使用该账号完成。

淘宝nick:指的是淘宝账号名,不是邮箱。

小程序名称:需要注册的小程序名称,后续无法修改变更,谨慎。

申请业务说明:小程序的业务说明。

2.2.5 AppKey 回填(运营操作)#

小程序appKey和商家端appKey(如果存在)应用创建后,服务商可在淘宝开放平台查询应用appKey,secret等:

小程序appKey:在“阿里生态开放API”下,所在类目是“闲鱼垂直行业-C端”。

商家端appKey:在“阿里生态开放API”下,所在类目是“闲鱼垂直行业-B端”。

服务商将两个appkey同时群里同步给运营,运营进行后续的appKey回填。

运营回填之后,服务商sdk里就可以获取到相应的API代码,闲鱼小程序初步创建完成了。

3. 开发小程序#

3.1 完善小程序信息#

appKey申请通过之后,进入闲鱼三方开放平台,点击右侧新建。

填写对应数据

❗ 基本信息注意项#

isv容器地址域名只能加白一些必要的第三方工具H5地址(非isv自己的页面比如fadada签约工具),其他的一律不允许填写!!!,如果要填写提前找闲鱼开发确认

3.2 申请API权限(申请此权限后,才能正常调通API)#

开发小程序之前,需要到管理平台上为对应小程序申请相关权限。点击对应小程序右方的「申请权限」按钮进入权限申请列表页

3.3 权限介绍#

点击申请权限,会进入到对应页面,小程序的权限分为两部分:

TOPAPI:服务端相关的API

WindvaneAPI:小程序调用的相关前端API

小程序开发者按照自身需求,按要求填写权限过期时间和使用说明,发起权限申请

❗ 权限包注意项#

目前普通的常规小程序只开放以下权限包供申请,(最小权限原则,按需要申请,不够可以后续再申请!!!)

TOPAPI (服务端)#

userIsBindAccountQuery: TOP账号是否绑定支付宝查询

userAgeQuery: TOP年龄信息查询

userPhoneQuery: TOP用户手机号查询

orderVirtualDelivery: TOP无物流虚拟发货

userInfoQuery: TOP用户信息查询

orderClose: TOP关闭订单-发货前

refundQuery: TOP退款查询

orderQuery: TOP订单查询

partRefundBySeller: TOP部分退款

refundBySellerAfterSendGoods: TOP全部退款-发货后退款

orderCreateTopApi: TOP创建订单接口

orderShip: TOP实物物流发货 (如果涉及实物物流发货,申请此接口,不需申请 orderVirtualDelivery)

logisticsCompaniesQuery: TOP物流公司编码查询 (如果涉及实物物流发货,申请此接口,不需申请 orderVirtualDelivery)

WindvaneAPI (前端)#

openSystem: 打开外部应用

audio: 麦克风

getPhoneNumber: 获取闲鱼用户的手机号

saveImage: 保存图片到相册

tradePay: Alipay付款

clipboard: 剪切板

deliveryAddress: 收货地址列表 (实物发货情况下申请这个)

location: 地理位置

photo: 相册

3.4 开发和调试#

因为闲鱼小程序其实是能力增强,受到平台管控的H5,所以开发小程序跟开发H5别无太大差别。

开发时会调用闲鱼小程序容器提供的API,所以需要手动引入JS-SDK:

https://o.alicdn.com/idleFish-F2e/miniapp-uni-api/index.js

这里需要注意几点:

闲鱼小程序内部打开页面,直接使用window.location.href

小程序内部支持hash和history模式

小程序支持本地调试,具体参考「开发-开发调试」文档,里面有更详细的说明

3.5 订单交易流程#

可参考常见问题里的一些常见案例:常见问题文档

3.5.1 发布一个通用闲鱼商品#

服务商创建卖家闲鱼账号,发布一款通用商品,分享宝贝发布群内,告知闲鱼技术进行查询定位到商品ID,统一使用这一个商品ID进行拉起创单。

商品的详细说明参考:商品如何发布及订单里的商品概念

3.5.2 订单的交易链路#

交易链路参考:订单的交易链路

3.5.3 请求接口身份说明#

身份说明参考:API调用身份说明

3.6 环境检测脚本#

闲鱼需要对上架的小程序进行一定的管控,所有上架的小程序必须要通过script标签接入闲鱼的环境检测脚本,否则无法通过上架审核

脚本链接:

https://o.alicdn.com/moyu-project/mini-app-static-assets/checkEvn.js

3.7 AI一键搬家#

3.7.1 AI一键搬家流程说明#

如果现有业务已经有小程序上架过支付宝或者微信平台,可使用平台提供的「AI一键转换」将已有的小程序转换为闲鱼小程序

将源代码压缩成zip包,点击选择文件上传zip包,点击确认转换代码,平台将启动转换服务

转换完成后,在转换记录中可以查看转换报告,下载转换后的代码

3.7.2 同城服务小程序AI一键搬家#

目前针对同城服务业务的小程序,为保障在闲鱼平台的兼容性与运行稳定性,来自其他平台的代码(uni-app、后续增加其他原生小程序)需先通过AI转码完成初始化适配,完成后可正常调试与发布集成

在发布前,需要上传应用的最终源代码。平台将使用最终源代码与AI转码结果进行对比分析,用于持续优化转码质量,提升后续开发体验。

源码仅用于转码效果的统计分析,不会用于其他用途。

4. 发布小程序#

这里主要简单介绍发布主流程,详细介绍请参考「开发-发布集成」文档

当开发和测试完成后,点击对应小程序右方的「发布集成」按钮进入发布集成页面,创建变更。进入小程序正式发布流程。

4.1 创建变更#

进入发布集成页面,点击右侧的创建变更

打开变更创建页面:

字段说明

字段名

描述

小程序入口

填写当前小程序的入口链接(首页链接)

对接闲鱼运营

填写对接小二的花名或真实姓名,用于问题跟进时,方便联系

计划发布时间

选择预计发布上线的时间

是否为第一次变更

当选择为是时,需额外上传ICP备案文件

是否涉及订单功能

小程序里是否涉及订单相关功能,或调用订单相关API

变更内容

填写本次变更涉及的模块内容,可附带测试文档

变更包上传

将产物压缩成zip包上传

测试图片上传

按测试要求提供相关测试完成的截图

附件

体验预览包与测试图片一致即可;正式发布的包需要上传视觉图、说明文档

ipc备案

ipc备案材料,用于闲鱼法务审核

4.2 变更包规范#

4.2.1 资源引用路径规范#

html文件中引用css、js文件需要使用相对路径:

❌ 错误:script type="text/javascript" src="/static/js/index.141c62c8.js">/script>

✅ 正确:script type="text/javascript" src="./static/js/index.141c62c8.js">/script>

4.2.2 资源文件规范#

使用到的资源也需要使用相对路径,闲鱼会将提供的图片资源上传到闲鱼的CDN。

注意事项:

a. 不支持自定义字体

b. 不支持大图资源(超过500KB建议压缩,下发的图片尽量控制在300K到500K)

c. 禁止发布线上的文件类型:gz文件、cconb类型文件、ccon文件、lnk文件

d. 不能以 .XXX 开头作为文件命名

e. 不可以加注释

f. 不支持汉语命名的文件名称,例如:前端页面.html / 自测图片.png / 自测代码.js

g. 整体文件数量不允许超过3000个

h. 单文件最大不超过20M,整体包大小超过60M会多次触发超时

4.2.3 禁止在发布产物中携带注释#

为了确保内容安全,禁止在发布产物中携带注释,请通过 webpack 等构建工具移除。

注: 包含 @preserve、@license、@cc_on 和 ! 开头的版权注释以及 Weex 文件中的 {"framework":"Rax"}、{"framework":"Vue"} 框架注释为白名单。

4.3 发布流程和节点说明#

变更提交后,可在列表及详情页查看目前变更所处流程节点