> For the complete documentation index, see [llms.txt](https://polyv.gitbook.io/document/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://polyv.gitbook.io/document/docs/vod/api/video-management/category/get_categories.md).

# 获取分类及子分类

### 接口描述

```
1、查询分类目录
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议
4、每个账户预设根目录，名字为默认分类
```

### 接口URL

```
http://api.polyv.net/v2/video/{userid}/cataJson
```

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/v2/video/%7Buserid%7D/cataJson/README.md)

### 请求方式

```
GET
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/limit/README.md)

### 请求参数描述

| 参数名    | 必选    | 类型     | 说明                                                                                                                                                                                                                                   |
| ------ | ----- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| userid | true  | String | 保利威点播账户id，可以参考【[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/getSecretKey/README.md)】获取，获取路径：官网->登录->点播（API接口）                                                                                      |
| ptime  | true  | Long   | 当前时间的毫秒级时间戳，3分钟内有效                                                                                                                                                                                                                   |
| sign   | true  | String | 签名，为40位大写的SHA1值,`生成签名的secretkey密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/buildSign/README.md)】，userid、ptime参与签名，cataid不参与 |
| cataid | false | String | 分类id，默认为1根目录                                                                                                                                                                                                                         |

### 示例

```requestUrl
http://api.polyv.net/v2/video/1b448be323/cataJson?sign=4CAE0A6A4C897B67EE7E9405806923B315F4C8A8&cataid=1617160372987&userid=1b448be323&ptime=1617172296970

```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                                                           |
| ------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| code    | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/errorInfo/README.md)】                              |
| status  | String  | 响应状态文本信息                                                                                                                                                     |
| message | String  | 响应描述信息，当code为400或者500的时候，辅助描述错误原因                                                                                                                            |
| data    | Array   | 响应成功时返回视频分类列表【详见[data字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/video_management/category/get_categories.md?id=data字段说明)】 |

#### data字段说明

| 字段          | 类型      | 说明                                                                                                                                                                   |
| ----------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| text        | String  | 分类名和该分类下视频总数的组合                                                                                                                                                      |
| cataname    | String  | 分类名                                                                                                                                                                  |
| catatree    | String  | 分类树，用逗号拼接从根目录到该目录每一层的分类id，例如："1,1617160372987"                                                                                                                       |
| cataid      | Long    | 分类id，如果为1则是根目录                                                                                                                                                       |
| parentid    | Long    | 上一级分类id，根目录的上一级分类为0                                                                                                                                                  |
| cataProfile | String  | 一级分类设置信息，分别为：加密、水印、课件优化、源文件播放。例如：加密                                                                                                                                  |
| videos      | Integer | 此分类及其子分类视频总数                                                                                                                                                         |
| nodes       | Array   | 该分类的子分类列表，没有子分类时此字段无效【详见[data字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/video_management/category/get_categories.md?id=data字段说明)】 |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 VodSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[点播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/vod/java/README.md)完成API的功能对接，点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
private static final Logger log = LoggerFactory.getLogger(VodVideoCategoryTest.class);

/**
 * 获取分类及子分类
 */
@Test
public void testGetVideoCategory() throws Exception, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String secretKey = super.secretKey;
        String userId = super.userId;
        String ptime = String.valueOf(System.currentTimeMillis());
        //业务参数
        String url = "http://api.polyv.net/v2/video/" + userId + "/cataJson";
        String cataId = "1617160372987";

        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("userid", userId);
        requestMap.put("ptime", ptime);
        //系统只部分参数进行签名
        requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
        requestMap.put("cataid", cataId);
        String response = HttpUtil.get(url, requestMap);
        log.debug("测试获取分类及子分类,{}", response);
        //do somethings
}


```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/errorInfo/README.md)

成功示例

```json
{
  "code": 200,
  "status": "success",
  "message": "success",
  "data": [
    {
      "text": "分类名称1 (0)  ",
      "cataname": "分类名称1",
      "catatree": "1,1617160372987",
      "cataid": 1617160372987,
      "parentid": 1,
      "cataProfile": "",
      "videos": 0,
      "nodes": [
        {
          "text": "分类名称1111 (0)  ",
          "cataname": "分类名称1111",
          "catatree": "1,1617160372987,1617173351969",
          "cataid": 1617173351969,
          "parentid": 1617160372987,
          "cataProfile": "",
          "videos": 0
        },
        {
          "text": "分类名称2222 (0)  ",
          "cataname": "分类名称2222",
          "catatree": "1,1617160372987,1617173363572",
          "cataid": 1617173363572,
          "parentid": 1617160372987,
          "cataProfile": "",
          "videos": 0
        }
      ]
    }
  ]
}

```

异常示例

```json
{
    "code": 400, 
    "status": "error", 
    "message": "the sign is not right.", 
    "data": ""
}
```