Query Category List

API Description

1、通过分类id分页查询分类列表
2、接口支持https协议

API URL

http://api.polyv.net/v3/category/get

Online API Call

Request Method

POST

API Constraints

1. The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls are subject to rate limits. See details

Request Parameter Description

Example

http://api.polyv.net/v3/category/get

Form parameters:

cateId=1608891483165&appId=a0Wmol5EwX&sign=2A0027CB75FEF9F24DD6B680A2FC20AE&timestamp=1617935598256

Response Parameter Description

error parameter description

data parameter description

category parameter description

subCategories parameter description

Java Request Example

For quick integration, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. The test cases include HttpUtil.java and VodSignUtil.java in the downloaded file.

It is strongly recommended to use the VOD Java SDK for API integration. The VOD Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private static final Logger log = LoggerFactory.getLogger(VodSubAccountTest.class);
/**
 * 查询分类列表
 * @throws Exception
 * @throws NoSuchAlgorithmException
 */
@Test
public void testSubGetCategories() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/v3/category/get";
    String cateId = "1608891483165";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("cateId", cateId);
    requestMap.put("sign", VodSignUtil.getSignMd5(requestMap, appSecret));

    String response = HttpUtil.postFormBody(url, requestMap);
    log.debug("测试查询分类列表,{}", response);
    //do somethings

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "requestId":"52ec91c6-4b2e-487e-976c-03378d3035af",
    "code":200,
    "status":"success",
    "error":null,
    "data":{
        "category":{
            "cateId":1608891483165,
            "cateName":"伪直播功能专用分类",
            "parentId":1
        },
        "subCategoryTotal":7,
        "subCategories":[
            {
                "cateId":1608891483169,
                "cateName":"2070151",
                "parentId":1608891483165
            },
            {
                "cateId":1610069551999,
                "cateName":"2087172",
                "parentId":1608891483165
            },
            {
                "cateId":1610605203885,
                "cateName":"2095792",
                "parentId":1608891483165
            },
            {
                "cateId":1615344036891,
                "cateName":"2149710",
                "parentId":1608891483165
            },
            {
                "cateId":1615357280260,
                "cateName":"2149813",
                "parentId":1608891483165
            },
            {
                "cateId":1616053580583,
                "cateName":"2205908",
                "parentId":1608891483165
            },
            {
                "cateId":1616572747765,
                "cateName":"1958888",
                "parentId":1608891483165
            }
        ]
    }
}

Error Example

Timestamp Error

{
    "requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
    "code": 400,
    "status": "error",
    "error": {
        "code": 100,
        "desc": "invalid timestamp"
    },
    "data": null
}

Incorrect appId

 {
     "requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
     "code": 400,
     "status": "error",
     "error": {
         "code": 101,
         "desc": "application not exist"
     },
     "data": null
 }

Sub-account does not exist

 {
     "requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
     "code": 400,
     "status": "error",
     "error": {
         "code": 102,
         "desc": "user children not exist"
     },
     "data": null
 }

Sub-account expired

 {
     "requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
     "code": 403,
     "status": "error",
     "error": {
         "code": 103,
         "desc": "user children expired"
     },
     "data": null
 }

Signature error

 {
     "requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
     "code": 403,
     "status": "error",
     "error": {
         "code": 104,
         "desc": "invalid signature"
     },
     "data": null
 }

Insufficient account permissions

 {
     "requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
     "code": 403,
     "status": "error",
     "error": {
         "code": 105,
         "desc": "permission limited"
     },
     "data": null
 }

Category does not exist

 {
     "requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
     "code": 400,
     "status": "error",
     "error": {
         "code": 3001,
         "desc": "category not exist"
     },
     "data": null
 }