开发指引

更新时间:2023.08.21

# 1. 接口规则

小店活动API,使用了全新的微信支付APIv3接口规则

# 2. 开发环境搭建

开发前需要正确配置私钥和证书APIv3密钥

# 2.1. 集成SDK

为了帮助开发者更好的调用接口,我们提供微信支付APIv3官方SDK,请根据自身开发语言,选择对应的SDK库集成到项目,并在商户平台配置平台证书

目前微信支付提供JAVA、GO两种语言版本的SDK,封装了签名生成、签名验证、敏感信息加/解密等基础接口功能。

各编程语言的SDK对“小店活动”的业务接口支持不一样,如若未支持相关业务接口,你可以使用SDK中的HTTP类实现发送HTTP请求,它会自动生成签名和验证签名。

SDK 说明
wechatpay-java (opens new window) Java SDK
wechatpay-go (opens new window) GO SDK

如下通用基础功能接口,已经在SDK中完成封装,可替换相关参数后快速测试。

  1. 签名生成
  2. 签名验证
  3. 敏感信息加解密
  4. merchantPrivateKey(私钥)
  5. wechatpayCertificates(平台证书)
  6. APIV3Key(V3 key) (opens new window)

若使用的编程语言无对应的SDK,则需要按照接口规则与接口详细信息自行开发。

# 2.2. 接口体验

如果开发者使用过PostmanAPI的调试,建议在正式开发之前,使用Postman签名脚本 (opens new window)进行接口体验。

# 3. 小店活动业务接入说明

# 3.1. 业代操作关键步骤说明

# 第一步:添加零售小店活动业务代理

1、调用接口前,开发者需要参考接入前准备确认已完成小店活动配置, 可以在活动详情页获取该活动的ID。

2、调用接口时,指定新增业代的名单,需要使用OpenID。

3、为确保更新顺序,需要保证每次调用add_time为当前时间。

4、添加零售小店活动业务代理的商户号必须是活动创建商户或活动归属品牌的品牌主商户或活动归属品牌的经营商户

# 第二步:删除零售小店活动业务代理

1、调用接口前,开发者需要参考接入前准备确认已完成小店活动配置, 可以在活动详情页获取该活动的ID。

2、调用接口时,指定删除业代的名单,需要使用添加业代时的OpenID,可以通过查询接口获取已添加的OpenID。

3、为确保更新顺序,需要保证每次调用del_time为当前时间。

4、删除零售小店活动业务代理的商户号必须是活动创建商户或活动归属品牌的品牌主商户或活动归属品牌的经营商户

# 第三步:查询零售小店活动业务代理

1、调用接口前,开发者需要参考接入前准备确认已完成小店活动配置, 可以在活动详情页获取该活动的ID。

2、查询零售小店活动业务代理的商户号必须是活动创建商户或活动归属品牌的品牌主商户或活动归属品牌的经营商户

# 3.2. 物料码操作关键步骤说明

# 第一步:生成小店活动物料码

1、生成小带你互动物料码的商户必须是品牌的品牌主或品牌服务商