分页查询商品
更新时间:2026-07-13 11:28:48
接口描述
1、分页查询标签
2、接口支持https协议
接口URL
https://api.polyv.net/live/v4/user/product/list
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| pageNumber | true | Integer | 当前页码 |
| pageSize | true | Integer | 分页大小 |
| keyword | false | String | 关键字搜索 |
| productType | false | String | 商品类型(normal:普通商品,finance:金融商品) |
示例
https://api.polyv.net/live/v4/user/product/list?appId=frlr1zazn3×tamp=1670471250000&sign=149397BFD607C518A841DAF8777D6A7E&pageNumber=1&pageSize=10
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 响应结果,由业务决定,成功返回true,失败返回false |
| data | Object | 标签分页数据【详见data字段说明】 |
| error | Object | 状态码非200时的错误信息【详见Error字段说明】 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| pageNumber | String | 分页页码 |
| pageSize | Integer | 分页大小 |
| totalPages | String | 总页数 |
| totalItems | String | 总记录数 |
| contents | Array | 商品数组 |
contents参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| productId | String | 商品id |
| name | String | 商品名称 |
| cover | String | 封面图, normal类型商品值不为空 |
| linkType | Integer | 商品链接类型, 10:通用链接,11:多平台链接 ,12:调用原生方法 |
| link | String | 商品链接不能为空 |
| productType | String | 商品类型,可能的值有: normal: 普通商品 finance: 金融商品 position:职位商品 |
| pcLink | String | pc端链接 |
| mobileLink | String | 移动端链接 |
| wxMiniprogramOriginalId | String | 微信小程序原始ID |
| wxMiniprogramLink | String | 微信小程序链接 |
| mobileAppLink | String | 手机APP链接 |
| iosLink | String | ios链接 |
| androidLink | String | android链接 |
| otherLink | String | 其他端链接 |
| features | String | 商品特色,卖点标签,可以多个,json数组 |
| tagIds | Array |
商品标签ID列表 |
| btnShow | String | 按钮显示文案 |
| productDesc | String | 商品描述 |
| productDetail | String | 商品详情,返回的是个内容存放的地址:例如 https://liveimages.videocc.net/product-info/product-detail/4d57ea01de/704007d1fdfd4cb2a5b3d3a842418831.json url存放的就是商品详情内容 |
| ext | String | 扩展信息:JSON对象字符串:{"coverList":["封面图地址,最多15个"], "videoList":[{"videoSource":"视频来源", "videoId":"视频ID"}]} 【详情见EXT】 |
| - | - | 以下为普通商品专用参数 (productType=normal) |
| priceType | String | 商品实际价格类型,可能的值有: AMOUNT: 金额 CUSTOM: 自定义 |
| realPrice | Float | 商品实际价格-金额,最高精确度为两位小数,如 12.34 |
| customPrice | String | 商品实际价格-自定义 |
| originalPriceType | String | 商品原始价格(划线价格)类型,可能的值有: AMOUNT: 金额 CUSTOM: 自定义 |
| price | Float | 商品原始价格(划线价格)-金额,最高精确度为两位小数,如 12.34 |
| customOrignalPrice | String | 商品原始价格(划线价格)-自定义备注:如果 price 和 customOriginalPrice 都为空,则表示不启用原始价格(划线价格) |
| - | - | 以上为普通商品专用参数 (productType=normal) |
EXT
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| coverList | true | Array | 封面图地址数组,最多15个 |
| videoList | false | Array | 视频数组,最多1个【详情见ChannelProductExtVideo】需要开通素材库才能用 |
| jumpWay | false | String | 购买方式为外链购买-通用链接的跳转方式: POP_UP-弹出框打开、NEW_WINDOW-新窗口打开、CURRENT_WINDOW-当前窗口打开 |
ChannelProductExtVideo
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| videoId | true | String | 视频ID |
| videoSource | true | String | 视频来源: MATERIAL_LIBRARY-素材库 |
商品详情productDetail url里存放内容示例
{
"productDetail": "<p>这是商品详情</p>"
}
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private final Logger log = LoggerFactory.getLogger(getClass());
/**
* 查询组织架构列表
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void getProductPageTest() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
Integer pageNumber = 1;
Integer pageSize = 10;
//业务参数
String url = "https://api.polyv.net/live/v4/user/product/list";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("pageNumber", pageNumber);
requestMap.put("pageSize", pageSize);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询商品分页成功:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "9ccd6f6e-cf35-4d9e-8a0c-0fa9d214c592",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalPages": 1,
"totalItems": 1,
"contents": [
{
"productId": "1729060628513820672",
"name": "123",
"price": 0,
"cover": "//liveimages.videocc.net/uploaded/images/2023/11/gqzb4tybhf.jpg",
"link": "http://123.456.com",
"rank": 1,
"realPrice": 0,
"type": "demo",
"linkType": 10,
"pcLink": "",
"mobileLink": "",
"androidLink": "",
"iosLink": "",
"otherLink": "",
"wxMiniprogramLink": "",
"wxMiniprogramOriginalId": "",
"mobileAppLink": "",
"params": null,
"productType": "normal",
"btnShow": null,
"features": "[\"\", \"\"]",
"tagIds": [1001, 1002],
"productDesc": "",
"productDetail": "https://liveimages.videocc.net/product-info/product-detail/4d57ea01de/704007d1fdfd4cb2a5b3d3a842418831.json",
"yield": null
}
]
},
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
