接口URL
https://api.polyv.net/v3/category/get
接口说明
(接口调用有频率限制,详细请查看)
1、接口用于查询视频分类
2、接口支持https
请求方式
GET,POST
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | 是 | string | 子账号appId |
timestamp | 是 | long | 当前13位当前时间戳,3分钟有效 |
sign | 是 | string | 签名值,32位大写MD5值 |
cateId | 是 | long | 分类id |
page | 否 | int | 子分类列表页码 |
pageSize | 否 | int | 子分类每页大小 |
响应成功JSON示例:
// 获取成功
{
"requestId": "9a98f2aa-a52f-4105-87db-5697744dfcc6",
"code": 200,
"status": "success",
"error": null,
"data": {
"category": {
"cateId": 1594482470001,
"cateName": "分类名称",
"parentId": 1
},
"subCategoryTotal": 1,
"subCategories": [
{
"cateId": 1616569379561,
"cateName": "子分类名称",
"parentId": 1594482470001
}
]
}
}
响应失败JSON示例:
// 时间戳错误
{
"requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
"code": 400,
"status": "error",
"error": {
"code": 100,
"desc": "invalid timestamp"
},
"data": null
}
// appId不正确
{
"requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
"code": 400,
"status": "error",
"error": {
"code": 101,
"desc": "application not exist"
},
"data": null
}
// 子账号不存在
{
"requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
"code": 400,
"status": "error",
"error": {
"code": 102,
"desc": "user children not exist"
},
"data": null
}
// 子账号过期
{
"requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
"code": 403,
"status": "error",
"error": {
"code": 103,
"desc": "user children expired"
},
"data": null
}
// 签名错误
{
"requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
"code": 403,
"status": "error",
"error": {
"code": 104,
"desc": "invalid signature"
},
"data": null
}
// 账号权限不足
{
"requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
"code": 403,
"status": "error",
"error": {
"code": 105,
"desc": "permission limited"
},
"data": null
}
// 分类不存在
{
"requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
"code": 400,
"status": "error",
"error": {
"code": 3001,
"desc": "category not exist"
},
"data": null
}
字段说明
字段 | 说明 |
---|---|
requestId | 本次请求的ID |
code | 响应http状态码 |
status | 状态 |
error.code | 错误码 |
error.desc | 错误描述 |
data | 返回数据 |
data.category | 当前分类 |
data.category.cateId | 分类id |
data.category.cateName | 分类名称 |
data.category.parentId | 父分类id |
data.subCategoryTotal | 下一级子分类个数 |
data.subCategories | 下一级子分类列表 |
java请求示例
public void testGetCategory() {
String url = "http://api.polyv.net/v3/category/get";
// appId和加密串
String appId = "xxxxx";
String appSecret = "xxxxxxxxxxxxxxxxxxxxxxx";
long cateId = 1594482470001L;
Map<String, String> params = new HashMap<>();
params.put("cateId", String.valueOf(cateId));
params.put("page", String.valueOf(1));
params.put("pageSize", String.valueOf(10));
// 调用Polyv的工具类方法设置sign
PolyvTool.setLiveSign(params, appId, appSecret);
String content = HttpClientUtil.getInstance()
.sendHttpGet(url + "?" + PolyvTool.mapJoinNotEncode(params));
System.out.println(content);
}
签名规则及工具文件代码
https://dev.polyv.net/2020/liveproduct/l-api/rule/live-api-java-detail/