# 查询打点信息

### 接口描述

```
1、通过视频id获取单个视频的全部打点信息
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口URL中的{vid}为视频id
4、接口支持https协议
```

### 接口URL

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

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/v2/video/%7Buserid%7D/keyframe/%7Bvid%7D/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)】 |
| vid    | true | String | 视频id                                                                                                                                                                                                      |

### 示例

```requestUrl
http://api.polyv.net/v2/video/1b448be323/keyframe/1b448be323b8d9b9489dcd7e8e09f087_1?vid=1b448be323b8d9b9489dcd7e8e09f087_1&sign=9FD6BA6486D1655C1D1A27C436F835C43BEB8406&userid=1b448be323&ptime=1617174767293
```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                                                                                                     |
| ------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 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    | Object  | 请求成功时返回视频打点信息【详见[data字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/video_management/chapter_marker/get_chapter_marker.md?id=data%E5%8F%82%E6%95%B0%E6%8F%8F%E8%BF%B0)】 |

#### data参数描述

| 字段           | 类型     | 说明                                                                                                                                                                                                              |
| ------------ | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| duration     | String | 视频时长，格式为：HH:mm:ss，如：00:02:19                                                                                                                                                                                    |
| keyframeList | Array  | 打点信息列表【详见[keyframeList字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/video_management/chapter_marker/get_chapter_marker.md?id=keyframeList%E5%8F%82%E6%95%B0%E6%8F%8F%E8%BF%B0)】 |

#### keyframeList参数描述

| 字段               | 类型      | 说明                                       |
| ---------------- | ------- | ---------------------------------------- |
| id               | Integer | 打点ID                                     |
| seconds          | Integer | 打点时间点，单位秒                                |
| keyContent       | String  | 打点详情内容                                   |
| btnsettingswitch | String  | <p>打点按钮设置开关，不传表示关闭<br>Y：为开启<br>N：为关闭</p> |
| btndesc          | String  | 按钮描述                                     |
| btnhref          | String  | 按钮跳转地址                                   |

### 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(VodChapterMakerTest.class);
/**
 *查询打点信息
 * @throws Exception
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetChapterMaker() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String vid = "1b448be323b8d9b9489dcd7e8e09f087_1";
    
    String url = String.format("http://api.polyv.net/v2/video/%s/keyframe/%s",userId,vid);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("userid", userId);
    requestMap.put("ptime", ptime);
    requestMap.put("vid", vid);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    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": {
        "duration": "00:02:19",
        "keyframeList": [
            {
                "seconds": 10,
                "keyContent": "测试打点10s"
            },
            {
                "seconds": 20,
                "keyContent": "测试打点20s"
            }
        ]
    }
}
```

异常示例

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