# 获取视频封面

### 接口描述

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

### 接口URL

```
http://api.polyv.net/v2/video/{userid}/get-image
```

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

### 请求方式

```
GET
```

### 接口约束

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

2、sign（签名）的拼接规则是：ptime=参数\&t=参数\&vid=参数，并和sign一起通过url传递

### 请求参数描述

| 参数名    | 必选    | 类型      | 说明                                                                                                                                                                                                        |
| ------ | ----- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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，例如：1b448be3235552e5fafb16489eb01839\_1                                                                                                                                                               |
| t      | false | Integer | 值为1时，表示获取视频首图的缩略图                                                                                                                                                                                         |

### 示例

```requestUrl
http://api.polyv.net/v2/video/1b448be323/get-image?vid=1b448be323dec2a7bed6db61bd7d8a77_1&t=1&sign=A722F1E5307046E824C4AA857B8D2B9DEA43A6CA&ptime=1617263701543
```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                              |
| ------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
| 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    | 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(VodVideoPosterTest.class);
/**
 * 获取视频封面
 */
@Test
public void testGetPoster() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userid = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/v2/video/%s/get-image",userid);
    String vid = "1b448be323dec2a7bed6db61bd7d8a77_1";
    String t = "1";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("vid", vid);
    requestMap.put("t",t);

    //系统只部分参数进行签名
    Map<String, String> signMap = new HashMap<>();
    signMap.put("ptime", ptime);
    signMap.put("vid", vid);
    signMap.put("t",t);
    requestMap.put("sign", VodSignUtil.getSign(signMap, 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": "http://img.videocc.net/uimage/1/1b448be323/7/1b448be323dec2a7bed6db61bd7d8a77_0.jpg"
}
```

异常示例

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