积分服务集成

> 通过接口集成，可以在易企秀活动中直接使用您现有的积分体系。

## 使用步聚
1. 根据接口规范开发（或由易企秀代开发）对应的集成接口；
2. 在易企秀控制台密钥管理中配置回调密钥；
3. 在易企秀控制台应用管理中启用积分模块，并配置集成接口；
4. 在活动中加入积分组件或直接使用带有积分玩法的活动模板；

## 接口开发说明

### 接口规范

- 请求方式：POST
- 数据格式：json
- 接口入参
| 参数名 | 是否必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| nonce | 必须 | String | 随机字符串，一般为UUID |
| timestamp | 必须 | Long | 当前 UNIX 时间戳，可记录发起 API 请求的时间。例如1529223702 |
| signature | 否 | String | 请求签名，防止请求数据被篡改，如果需要更高的安全等级，请添加此参数。 |
| msgEncrypt | 必须 | String| 加密的数据明细，明文参数见下文具体接口 |

- 请求参数示例
```json
{
	"msgEncrypt": "qguoHOFLPNPuUBIMwd+DJXzZzU0npUmwsdNpOthzir8mbql0uPEuBps873GSIc6Z",
	"nonce": "8d1e06d655df433bb8363877ad35fc70",
	"signature": "f6f8b7088037ec7fa06c42965c0efaf8a19f9c14",
	"timestamp": "1625486567366"
}
```

- 接口出参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| success | 是 | boolean | true，false |
| code | 是 | String | 200，成功 |
| msg | 是 | String | 非200时提示信息，例如：一分钟只能发送一次 |
| obj | 否 | Object | 根据具体的业务确定 |
| list | 否 | List | 根据具体的业务确定 |
| map| 否 | Map | 根据具体的业务确定 |

- 接口出参示例
```json
{
    "success": true,
    "code": "200",
    "msg": "ok",
    "obj": null,
    "map": null,
    "list": []
}
```

### 积分余额查询接口
- msgEncrypt明文参数
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| openId | 是 | String | 通过对接您的访客体系，获得的用户唯一ID |

- 接口出参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| success | 是 | boolean | true，false |
| code | 是 | String | 200，成功 |
| msg | 是 | String | 非200时提示信息，例如：一分钟只能发送一次 |
| obj | 是 | Int | 当前积分余额 |

### 积分变更接口
- msgEncrypt明文参数
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| requestId | 是 | String | 请求UUID，32位字符串 |
| openId | 是 | String | 通过对接您的访客体系，获得的用户唯一ID |
| point | 是 | Int | 变更分值，正数为加分，负数为减分 |
| changeType | 是 | String | 变更业务类型,[见字典](https://hc.eqxiu.cn/doc/18/#h2-u79EFu5206u53D8u66F4u4E1Au52A1u7C7Bu578Bu5B9Au4E49 "见字典") |
| bizId | 是 | Int | 变更业务ID,根据业务类型不同ID含议不同，可能是活动ID、作品ID |
| remark | 否 | String | 业务描述,一般为活动名称,商品名称 |

- 接口出参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| success | 是 | boolean | true，false |
| code | 是 | String | 200，成功 |
| msg | 是 | String | 非200时提示信息，例如：一分钟只能发送一次 |
| obj | 是 | Int | 变更后余额 |

### 积分变更明细
> 非必须，用于积分明细组件

- msgEncrypt明文参数
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| openId | 是 | String | 通过对接您的访客体系，获得的用户唯一ID |
| type | 否 | Int | 变更类型 |
| pageNo | 是 | Int | 分页参数 |
| pageSize | 是 | Int | 分页参数 |

- 接口出参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| success | 是 | boolean | true，false |
| code | 是 | String | 200，成功 |
| msg | 是 | String | 非200时提示信息，例如：一分钟只能发送一次 |
| list | 是 | List | 变更明细数据 |
| map | 是 | Map | 分页信息，含pageNo,pageSize,count |

### 积分排行榜接口
> 非必须，用于排行榜组件

- msgEncrypt明文参数
| 参数名 | 是否必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| campaignId | 是 | Long | 通过对接您的访客体系，获得的用户唯一ID |
| showNum | 是 | Int | 排行榜显示行数 |
| openId | 否 | String | 当前用户ID，传入该参数后会返回当前用户排行 |

- 接口出参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| success | 是 | boolean | true，false |
| code | 是 | String | 200，成功 |
| msg | 是 | String | 非200时提示信息，例如：一分钟只能发送一次 |
| obj | 否 | Int | 当前访客排行 |
| list | 是 | List | 排行数据 |

## 配置说明
待补充