APP调起签约
更新时间:2025.09.18简介
商户在完成“委托代扣APP预签约”后,可在移动端应用APP中集成开放SDK调起微信,请求用户签约。
接入前注意事项
在接入前需详细阅读下方说明:
商户在使用WXLaunchMiniProgram调起APP签约前,需要邮件申请,请参考委托代扣-APP纯签约申请流程
预签约成功后,首次调起微信有严格的时间限制:需在 2 分钟内调起微信(该时间将来会调整,最短可能缩短至 20 秒)。因此,建议在确认用户有签约意愿后再发起预签约,且预签约一旦成功,需立即通过 SDK 调起微信,以确保流程顺利进行
接口说明
接口名称:WXLaunchMiniProgram
注意事项:移动应用需要上架,开放平台账号需要已通过认证。参考文档:功能介绍
Android
Android openSDK下载地址(版本>=5.3.1):Android资源下载
Android 接入文档链接:openSDK说明文档
iOS
iOS openSDK下载地址(版本>=1.8.4):iOS资源下载
iOS 接入文档链接:openSDK说明文档
鸿蒙
鸿蒙 openSDK下载地址:鸿蒙资源下载
鸿蒙 接入文档链接:openSDK说明文档
请求参数
名称 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
跳转签约小程序的username | userName | 是 | String(32) | gh_xxxxxxxxxxxxx | 跳转签约小程序的username,可从预签约接口的返回参数
|
跳转签约小程序的path | path | 是 | String(256) | pages/index/index?xxxxxx | 跳转签约小程序的path,可从预签约接口的返回参数 |
跳转的小程序版本 | miniprogramType | 是 | Integer | 0 | 固定传值为0(正式版) |
请求示例
返回参数
返回参数内容无需关注,如果签约成功,商户系统会收到“签约、解约结果通知”,可参考使用的预签约文档目录下的“签约、解约结果通知”文档,例如查看的是V3“合单代扣”下的预签约文档,则查看V3“合单代扣”下的“签约、解约结果通知”文档。
存量委托代扣模板升级指引、存量委托代扣模板适配鸿蒙系统指引
2025年9月23日之前申请的模板(称之为“存量模板”),当时接入APP签约已申请OpenBusinessWebview Open SDK API的权限。
2025年9月23日之后(包括9月23日)申请的模板,以及2025年9月23日之前没有接入过APP签约的模板,不再支持OpenBusinessWebview权限申请,商户只可使用WXLaunchMiniProgram Open SDK API来调起微信签约。
建议存量模板改为使用WXLaunchMiniProgram调起微信签约,优点:跳转微信耗时更短、用户体验更好、支持鸿蒙。二者对比见下表:
API对比 | OpenBusinessWebview | WXLaunchMiniProgram | |
---|---|---|---|
跳转微信耗时 | 中等 | 更短 | |
用户体验 | 中等 | 更好 | |
支持Android | 是 | 是 | |
支持iOS | 是 | 是 | |
支持鸿蒙 | 否 | 是 | |
新增模板是否可以使用 | 禁用 | 按照上方“接入前注意事项”流程发邮件,运营配置后,可以用 | |
存量模板是否可以使用 | 若之前没接入过APP签约 | 禁用 | 按照上方“接入前注意事项”流程发邮件,运营配置后,可以用 |
若之前按OpenBusinessWebview流程接入过APP签约 | 可以用,邮件申请关闭OpenBusinessWebview后,禁用 | 按照下方切换Open SDK API流程发邮件,运营配置后,可以用 |
为了帮助商户平滑切换,切换Open SDK API有如下流程:
1、商户需要确认:预签约接口返回的miniprogram_username
和miniprogram_path
参数,不会对商户自身业务逻辑产生影响。此外,若商户使用的是APIv2接口做预签约(对应文档直连模式APP纯签约或服务商模式APP纯签约),还需重点关注商户侧校验响应签名sign
的逻辑,并确保该逻辑符合 API v2 接口的签名规则。
2、发送邮件申请,参考委托代扣-APP纯签约申请流程文档中“存量委托代扣模板升级、存量委托代扣模板适配鸿蒙系统”标题的第一步。
运营会针对这些模板做配置,配置完毕后,使用这些模板预签约后,预签约接口会返回 |
3、当商户代码开发完毕且上线后,如果确认商户的低版本APP(包括安卓、iOS)不再用OpenBusinessWebview(或者商户低版本APP做好了引导用户升级APP的提示),那么就可以发邮件,完成升级,参考委托代扣-APP纯签约申请流程文档中“存量委托代扣模板升级、存量委托代扣模板适配鸿蒙系统”标题的第二步。
运营配置完毕后,模板只支持WXLaunchMiniProgram这一种API调起微信签约,升级完毕。 |