查询产品配置与生效营销策略

接口说明

适用场景:【签约前查询】拉取产品配置及当前生效中的定价策略列表。

请求方式:【POST】/v1/subscription/product/query

请求域名:【主域名】https://api.baofu.com

请求参数

Header HTTP头参数

Header 必填 说明
Authorization 统一网关鉴权;签名算法与签名参数见下表(须在一行内,勿换行)
Content-Type 固定 application/json

宝付要求请求通过HTTP Authorization头来传递签名。Authorization由认证类型和签名信息两个部分组成。

Authorization: 认证类型 签名信息

具体组成为:

  • 认证类型,取值 RSA/SM2

签名信息

参数名 说明
mch_id 宝付分配的唯一商编
app_id 宝付终端号,选填,若传值,则使用宝付4.0证书
nonce_str 请求随机串,和上面构造签名串的随机串要保持一致
timestamp 时间戳 和上面构造签名串的时间戳要保持一致
serial_no 商户API证书序列号,用于声明所使用的证书
baofu_serial_no 宝付证书序列号, 联系技术支持提供
dgtl_envlp 数字信封(非必填),16位密钥,用宝付公钥加密后传输
signature 签名值,上面算出来的签名值

注意:以上七项签名信息,无顺序要求。数字信封参数可以为空

Authorization头的示例如下:(注意,示例因为排版可能存在换行,实际数据应在一行)

Authorization: RSA mch_id="128308",app_id="128308",nonce_str="P7X2R9Z1M5W6Q4V3B8C0D2E1F7G9H2J4",signature="DKLJASKLFGHQWJFPWQJLFKGDKSLGJPQJPFWQJLGKNDLSKJGLDSJLKFSJAKL",timestamp="1507488238",serial_no="123821002",baofu_serial_no="123822342",dgtl_envlp="GLKUIOWQGKDLSNGLKQWJPRQ"

body 包体参数

unifiedMemberNo  必填(由 Header 覆盖) string

【统一会员编号】以 mch_id Header 为准,服务端自动填入


externalProductCode  选填 string(64)

【外部产品编号】可选过滤条件,为空则返回该会员下所有产品


响应参数

成功时 data 类型为 JSON 数组array),每个元素为一个「产品 + 策略」组合对象:

product  object

【产品配置对象】

属性
unifiedMemberNo  string【统一会员编号】配置归属
productCode  string【内部产品编码】
externalProductCode  string【外部产品编号】
productName  string【产品名称】
cycleType  string【周期类型】如 MONTH,见数据字典与枚举说明1.3
cycleValue  number【周期值】
fixedDay  number【固定扣款日】依周期模型
baseAmount  number【基础金额】单位:分
totalPeriod  number【总期数】null 表示永续订阅
currency  string【币种】如 CNY
status  string【状态】ENABLED / DISABLED
description  string【描述】

strategies  array

【生效中的定价策略列表】按优先级降序排列,无生效策略时为空数组 []

属性
unifiedMemberNo  string【统一会员编号】
strategyCode  string【策略编码】
productCode  string【内部产品编码】
merchantNo  string【商户号】可空表示通配
pricingType  string【定价类型】如 FIRST_PERIOD_DISCOUNT,见数据字典与枚举说明1.6
priority  number【优先级】降序排列
strategyParams  string【策略参数JSON】
effectiveStart  string【生效开始时间】
effectiveEnd  string【生效结束时间】
status  string【状态】ENABLED / DISABLED

错误码

状态码 错误码 描述 说明
400 PARAM_ERROR 参数校验失败 统一会员编号缺失、产品不存在
503 SERVICE_UNAVAILABLE 配置查询失败 配置中心不可用
504 SYSTEM_ERROR 远程调用失败 配置中心超时
500 SYSTEM_ERROR 系统异常 内部系统错误