评论数据外部查询
1. 前言:
2. 交互时序图:
3. 请求场景:
分页请求来伊份评论数据,接口最大分页请求100条,默认根据评论ID倒序排序
4. 接口要求:
使用来伊份openapi加密协议进行加密请求
5. 接口标准
5.1 基本信息
描述 | 值 |
---|---|
服务名称 | comment-app-api |
URL | 测试环境:https://openapi.test.laiyifen.com/comment-app-api/comment/out/v1/page 生产环境:https://openapi.laiyifen.com/comment-app-api/comment/out/v1/page |
认证方式 | openapi认证 |
请求方式 | HTTP(GET) |
功能描述(适用场景) | 评论数据分页查询接口 |
5.2 请求头公共参数 (Header)
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
X-Co-Client | String | 是 | 客户端Id(来伊份提供) |
X-Co-Sign | String | 是 | 签名 |
X-Co-TimeStamp | String | 是 | 签名时间戳 |
5.3 入参 Parameters
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
pageNo | Integer | 是 | 分页页码 |
pageSize | Integer | 是 | 分页大小,支持最大100 |
startTime | Date | 是 | 一天的开始时间(查询一天) |
endTime | Date | 是 | 一天的结束时间 |
5.4 入参示例
?pageNo=1&pageSize=100&startTime=2023-06-18%2000:00:00&endTime=2023-06-18%2023:59:59
5.5 返回统一参数
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
code | String | 是 | 返回请求业务代码 |
msg | String | 是 | 返回信息描述 |
data | PageInfo | 是 | 评价分页数据 |
5.6 返回参数Data
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
id | Long | 是 | 评论id |
userId | Long | 是 | 用户id |
businessNo | String | 是 | 评价类型业务唯一编码(如订单类型,唯一标识为订单号) |
commentCode | String | 是 | 评论编号 |
commentStatus | Integer | 是 | 评价状态:1-未评价、2-已评价、3-已过期未评价(评价聚合实体总状态) |
contentCode | String | 是 | 评价内容编号 |
skuCode | String | 是 | sku编码 |
skuName | String | 是 | 商品名称 |
skuPicUrl | String | 是 | 商品图片 |
parentCommentId | Long | 是 | 父级评价id |
userName | String | 是 | 用户名称或用户昵称 |
userImg | String | 是 | 用户头像 |
score | Double | 是 | 评分:初始分数0.0分,设置最小为0.5,10个档次 |
scoreLevel | Integer | 是 | 评价级别:3-好评、5-中评、6-差评 |
contentStatus | Integer | 是 | 0-初始化、1-未审核、2-系统审核通过、3-系统审核不通过、4-人工审核通过、5-人工审核不通过、6-系统自动审核通过 |
content | String | 是 | 评价内容 |
commentTime | Date | 是 | 评价时间 |
commentOutAnnexList | List | 是 | 评价附件列表 |
5.7 返回示例
{
"data": {
"list": [
{
"id": 15524,
"userId": 100000841,
"commentType": 1,
"businessNo": "8412023071014055861697335",
"commentCode": "C1678285632028442624",
"commentStatus": 2,
"contentCode": "CT1678285632028442625",
"skuCode": "18362",
"skuName": "葵大仁原味瓜子20g",
"skuPicUrl": "https://static3.laiyifen.com/files/ody-cdn/1527848285075_2.760830274010284_bd01a755-5b9d-46cc-83eb-9828a6cafc8f.jpg",
"parentCommentId": null,
"userName": "伊客08071810",
"userImg": "https://static1.laiyifen.com/test-files/guide/image/1569324549239_3812.jpg",
"score": 4.5,
"scoreLevel": 3,
"contentStatus": 6,
"content": "很好吃,好评",
"commentTime": "2023-07-10T06:12:01.000+00:00",
"commentOutAnnexList": [
{
"annexType": 1,
"annexUrl": "https://static1.laiyifen.com/test-files/comment/image/comment/116a0774a54f49059ec3dec5524f0fb5.jpg"
}
]
}
],
"total": 1,
"totalPage": 1
},
"code": "0",
"msg": "success"
}