奖品库集成

> 实现中台与企业自有奖品库打通。支持奖品代码、电子兑奖码两种对接方式。

## 奖品代码集成第三方系统
### 功能效果
集成对接前，如下图，奖品码为手动输入
![](/media/202207/2022-07-14_111550_471524.png)
集成对接后，如下图，奖品码选择，奖品以及奖品的库存来源于合作方
点击查询按钮会实时查询合作方接口，获取奖品信息
![](/media/202207/2022-07-14_111957_073332.png)
### 配置接口
【应用管理】-【互动编辑器】
![](/media/202207/2022-07-14_111202_973027.png)

![](/media/202207/2022-07-14_111411_620850.png)
在配置的接口地址上拼eqs_uid_open=1参数后，在请求该接口时header中会携带eqsUidOpen(当前员工的openId)。
### 配置说明
|页面名称|使用说明|
|---|---|
|库名|用来区分配置|
|奖品定义查询接口|接口地址|
|奖项设置成功信息通知接口|用来通知某个奖项最后设置的数量|
|对接奖品类型|可选择多个，分别在奖项选择时对应类型时，才会出现选择奖品|
|是否开启|开启：配置生效，关闭：配置不生效|

### 接口规范
- 奖品定义查询接口
- 方法类型：POST
- Content-Type：application/json
- 接口入参
| 参数名 | 是否必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| nonce | 是 | String | 随机字符串 |
| timestamp | 是 | Long | 当前 UNIX 时间戳，可记录发起 API 请求的时间。例如1529223702 |
| signature | 是 | String | 请求签名。 |
| msgEncrypt | 是 | String | 数据明细,不同业务类型，数据格式不一样 |

- msgEncrypt解密数据格式 
| 参数名 | 是否必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
|corpOpenId|否|String|平台使用，子企业唯一标识|
|prizeName|否|String|奖品模版名称,可模糊查询|
|prizeCode|否|String|奖品模版代码,可模糊查询|
|prizeType|是|int|奖品类型[0、礼品 1、优惠券 4、积分]|
|creationId|否|long|作品ID|
|pageSize|否|int|每页大小，默认20|
|pageNo|否|int|第几页，默认1|

- 接口返回值
| 参数名 | 是否必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
|code|是|String|状态码，200请求正确，其他视为失败|
|msg|否|String|返回消息|
|list|是|List|prizeName奖品名称 prizeCode 奖品代码", surplus 剩余库存数（不返回该字段或者返回值为-1时表示无限库存） prizeImgUrl 奖品图片链接 没有可不传 redemptionMethod: 兑奖方式 linkType：链接类型 redemptionAddr: 跳转地址|
|map|是|Map|count列表查询总条数|
至少包含code和msg参数。
```json
{
 "code": 200,
 "msg": "操作成功",
 "obj": {},
 "map": {
 "pageNo": 1,
 "count": 1,
 "pageSize": 10,
 "end": true
 },
 "list": [
 {
 "prizeName": "奖品名称",
 "prizeCode": "奖品代码",
 "surplus": 1, // 剩余库存数,
 "prizeImgUrl": "https://wework.qpic.cn/wwhead/nMl9sso",
 "redemptionMethod": "webClaim" // 可选值webClaim： 网页兑奖，outClaim: 外部兑奖
 "linkType": "webAddress" // 可选值webAddress： 网页地址，miniProNormalAdr: 小程序普通地址， miniProTabAdr： 小程序tabbar地址
 "redemptionAddr": '' //跳转地址
 }
 ]
}
```
- 奖项设置成功信息通知接口
- 方法类型：POST
- Content-Type：application/json
- 接口入参
| 参数名 | 是否必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| nonce | 是 | String | 随机字符串 |
| timestamp | 是 | Long | 当前 UNIX 时间戳，可记录发起 API 请求的时间。例如1529223702 |
| signature | 是 | String | 请求签名。 |
| msgEncrypt | 是 | String | 数据明细,不同业务类型，数据格式不一样 |

- msgEncrypt解密数据格式 
| 参数名 | 是否必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
|prizes|是|list|奖品信息|
|prizes.prizeCode|是|String|奖品代码|
|prizes.prizeName|是|String|奖品名称|
|prizes.prizeNum|是|int|奖品使用数量|
|id|是|String|作品id|
|time|是|String|使用时间|
```json
{
	"prizes": "[{\"prizeCode\":\"prize13\",\"prizeName\":\"测试13\",\"prizeNum\":3}]",
	"id": "234",
	"time": "2024-03-06 13:50:23"
}
```

## 奖品代码人为填写
创建互动H5在设置奖项时，选择奖品或优惠券，并填写奖品代码。如下图：
奖品代码为企业奖品库的一类奖品标识，访客在中奖后，可通过此代码领取对应的奖品(会有事件推送，见下文)
此方式，奖品代码对应的奖品一般是同一种奖品。

![](/media/202205/2022-05-26_184859_729064.png)

## 数据推送
访客用于在抽奖中奖后，中台会将访客的中奖信息进行推送，企业需要设置数据接收的地址。
数据接收地址设置方式见“[数据回传](https://hc.eqxiu.cn/doc/24/)”。
数据推送对接方式见“[数据推送](https://hc.eqxiu.cn/doc/24/)”
访客中奖数据推送格式见“[活动中奖](https://hc.eqxiu.cn/doc/52/)”