帮助中心  /  第三方奖品接口

第三方奖品接口

接口功能说明

该接口用于发放第三方自有奖品体系,丰富奖品类型,打通用户系统中奖品领取。

该解决方案包含2个接口,《第三方奖品发放》接口用于对接第三方奖品,发放自有用户体系内的奖品、优惠劵等,可以同步发放到自有系统中比如APP、小程序等;《第三方奖品库》接口用于对接商家自有奖品体系,方便在人人秀平台快捷选择设置。


1.第三方奖品发放接口


开发注意:

  • 该接口由第三方开发者提供给人人秀调用,必须设置该接口地址

  • 开发者接收到参数,必须先将参数urldecode处理,然后计算签名

  • contacts 参数类型是json字符串,解析时需要注意转化成对象处理

请求地址

由第三方平台提供

请求方式

POST 方式,Content-type:application/x-www-form-urlencoded

参数说明

参数名称

是否必须

说明

app_key

人人秀平台分配的AppKey

time_stamp

1970-01-01开始的时间戳,精确到毫秒

sign

根据签名算法计算所得,如何计算签名

openid

活动用户唯一标识

nickname

用户昵称

headimgurl

用户头像地址

order_no

人人秀订单号

prize_code

奖品标识码(用于开发者识别要发放的奖品)

phone

该字段提取contacts里的手机号,

只有在contacts里有手机号时才有值,方便开发者通过手机号发奖

contacts

该字段为开启活动报名填写的信息。

该字段为JSON数组字符串

[{"id":"1","name":"姓名","value":"zcho"},

{"id":"3","name":"手机","value":"13635603333"}]

h5_guid

活动 GUID,活动场景有值

响应参数

参数

是否必须

参数说明

result

0:成功   1:失败

msg

result为1时,返回错误原因

data

result为0时,返回的第三方奖品展示信息

响应示例

成功

{"result":0,"msg":"","data":[{"name":"名称","value":"名称值"}],"link":{}}

失败

{"result":1,"msg":"没有领奖资格"}


data参数说明

参数是否必填参数说明
name

数组中一行的列名
value

数组中一行的列值


link参数说明

参数

是否必填项

参数说明
type

链接类型,1:普通链接;2:小程序链接;

当返回link参数后,领取奖品会直接跳转link链接,进入我的奖品可再次查看奖品详情

url

普通链接时必填,跳转的链接地址
username

小程序链接时必填,H5跳转小程序传APPID  以 wx开头;

小程序环境访问,跳转当前嵌入小程序页面可空(如果需跳转到新小程序,需先带参跳转自己小程序页面)

path

小程序链接时必填,需跳转的小程序页面路径 以 /xx开头

tabbar页面不支持(嵌入页面无法识别当前小程序tabbar)

button_text

跳转链接按钮文案,当有link数据时,显示在奖品详情页面底部


对接步骤

第一步,对接收的参数进行urldecode处理

第二步,计算签名和验证签名

第三步,返回处理结果,返回值必须是json格式,即 Content-type: text/json


 

请求示例

{

    "app_key""96c84928b1dce057d110ea3b3880fc83",

"time_stamp":"1543999047492",

"sign ":"051BF3517D40AB9D7D6B45EF6E4EB7F9",

"openid ""gb_1543999047492",

"nickname""小张子",

"headimgurl""https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TMaE…zXTfZQugNBA/132",

"order_no""1543999047492",

"prize_code""zp_001",

"phone""15811111111",

"h5_guid""123456",

"contacts ": [

         {"id":101,"name":"姓名","value":"张三"},

         {"id":103,"name":"手机号","value":"15811111111"},

]

}

 

 

 

返回值示例,json格式 Content-type: application/json

{

    "result"0,

"data"[

{"name""劵号","value""3932933"},

{"name""使用说明","value""到店请主动出示给店员"}

],

"link"{

"type""1",

"url""https://",

"button_text""点击查看奖品"}

}

    "msg""ok"

}



2.第三方奖品库接口


开发注意:

  • 该接口由第三方开发者提供给人人秀调用,设置后可用

  • 开发者接收到参数,必须先将参数urldecode处理,然后计算签名

请求地址

由第三方平台提供

请求方式

POST

参数名称

是否必须

说明

app_key

人人秀平台分配的AppKey

time_stamp

1970-01-01开始的时间戳,精确到毫秒

sign

根据签名算法所得,如何计算签名

 login_id

登录账号,查询指定账号数据。   查看子账号账号 

空则是主账号,查询主账号数据否则查询子账号对应数据

name搜索的内容,仅搜索时有值

page

第几页数据

limit

每页多少条数据

返回JSON格式结果

{"result":0,"msg":"","data":{}}

参数名称

说明

result

0表示成功,1表示失败

msg

表示失败详细描述

data

成功时,返回奖品数据


data参数说明

参数名称

是否必须

说明

total

数据总笔数

rows

数据列表


rows参数说明

参数名称

是否必须

说明

prize_name

奖品名称

prize_code

奖品标识


对接步骤

第一步,对接收的参数进行urldecode处理

第二步,计算签名和验证签名

第三步,返回处理结果,返回值必须是json格式


 

请求示例

{

    "app_key""96c84928b1dce057d110ea3b3880fc83",

"time_stamp":"1543999047492",

"sign":"051BF3517D40AB9D7D6B45EF6E4EB7F9",

"login_id":'''',

"name":''抽纸'',

"page":1,

"limit":20

}

 

 

返回值示例,json格式 Content-type: application/json

{

    "result"0,

"data"{

  "total"1,

"rows" [

{

"prize_name""商品1",

"prize_code""zp_001"

}

]

    },

    "msg""ok"

}



相关文档