获取频道商品库商品列表

接口URL

https://api.polyv.net/live/v3/channel/product/list

接口说明

(接口调用有频率限制,详细请查看)

1、获取频道商品库商品列表
2、支持分页
3、接口支持https

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
channelId int 频道号
page int 当前页,默认1
size int 每一页数据大小,默认10,范围1-100,包涵边界

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 1,
        "pageNumber": 1,
        "totalItems": 9,
        "contents": [
            {
                "productId": 6290,
                "userId": "ee7fe7fbda",
                "channelId": 1779741,
                "name": "king d",
                "price": null,
                "cover": "//liveimages.videocc.net/uploadimage/20200827/chat_img_1779741_15985125681801.jpeg?x-oss-process=image/crop,x_95,y_0,w_235,h_235",
                "link": "",
                "status": 1,
                "createdTime": 1599560429000,
                "lastModified": 1599560470000,
                "rank": 17,
                "realPrice": 19.02,
                "type": "live",
                "linkType": 11,
                "pcLink": "https://www.msuno.cn",
                "mobileLink": "",
                "wxMiniprogramLink": "",
                "wxMiniprogramOriginalId": "",
                "mobileAppLink": "",
                "params": "{\"cc\": 11}",
                "showId": 9
            }
        ],
        "startRow": 1,
        "firstPage": true,
        "lastPage": false,
        "prePageNumber": 1,
        "limit": 1,
        "totalPages": 9,
        "endRow": 1,
        "nextPageNumber": 2,
        "offset": 0
    }
}

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

签名错误

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

非法频道

{
    "code": 403,
    "status": "error",
    "message": "illegal channel id: 1779742",
    "data": ""
}

非法参数

{
    "code": 400,
    "status": "error",
    "message": "param is not digit: size",
    "data": ""
}

字段说明

参数名 类型 说明
code int 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status string 成功为success,失败为error
message string 错误时为错误提示消息
data object 响应结果集
pageNumber int 当前的页数
totalItems int 总的条数
contents array 查询的结果列表
productId int 商品productId
userId string 用户userId
channelId int 频道号
name string 商品名称
price long 商品价格,保留两位小数,如:0.01
cover string 商品封面链接
link string 商品通用类型商品链接
status int 商品上下架状态
1:上架状态
2:下架状态
createdTime long 创建商品时间,毫秒级时间戳
lastModified long 更新商品时间,毫秒级时间戳
rank int 商品排序号
realPrice long 商品实际价格,保留两位小数,如:0.01
type string 平台标志,默认live,其他无效
linkType int 商品链接类型
10:通用链接
11:多平台链接
pcLink string 多平台链接,pc端跳转链接
mobileLink string 多平台链接,移动web端跳转链接
wxMiniprogramLink string 多平台链接,小程序端跳转链接
wxMiniprogramOriginalId string 多平台链接,小程序端Id
mobileAppLink string 多平台链接,移动App端跳转链接
params string 自定义参数,类型json对象,需要转为string
showId int 显示id
firstPage boolean 是否为第一页,值为:true/false
lastPage boolean 是否为最后一页,值为:true/false
nextPageNumber int 下一页编号
prePageNumber int 上一页编号
totalPages int 总页数
startRow int 当前页第一个数量的位置
endRow int 当前页最后一个数量的位置
limit int 每页数量大小

Java请求示例

public static void main(String[] args) {
        String url = "https://api.polyv.net/live/v3/channel/product/list";
        // 用户对应的appId和加密串
        String appId = "xxxxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
        Map<String, String> params = new HashMap<>();
        params.put("channelId", "0000000");
        params.put("page", "1");
        params.put("size", "10");
        PolyvTool.setLiveSign(params, appId, appSecret);
        // 调用Polyv的httpClient工具类发送请求
        String content = HttpClientUtil.getInstance()
                .sendHttpGet(url + "?" + PolyvTool.mapJoinNotEncode(params));
        System.out.println(content);
    }

签名规则(PolyvTool.java文件代码查看)

https://dev.polyv.net/2020/liveproduct/l-api/rule/live-api-java-detail/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...