# 获取观看页 SDK 授权令牌

### 接口描述

```
1、获取观众观看调用接口token
2、该token用于观看页SDK调用watch-api相关接口
3、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/live/v3/channel/watch/get-watch-api-token
```

### 请求方式

```
POST
```

### 接口约束

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

### 请求参数描述

| 参数名       | 必选    | 类型     | 说明                                                                                                                                                                                                        |
| --------- | ----- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId     | true  | String | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| timestamp | true  | Long   | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign      | true  | String | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |
| channelId | true  | String | 频道号                                                                                                                                                                                                       |
| viewerId  | true  | String | 观众viewerId，长度：1-64位字符                                                                                                                                                                                     |
| nickname  | false | String | 昵称                                                                                                                                                                                                        |
| avatar    | false | String | 观众头像                                                                                                                                                                                                      |
| openid    | false | String | 微信的openId                                                                                                                                                                                                 |
| actor     | false | String | 用户头衔                                                                                                                                                                                                      |

### 示例

```requestUrl
http://api.polyv.net/live/v3/channel/watch/get-watch-api-token
```

表单参数：

```requestUrl
viewerId=test1234&appId=frlr1zazn3&sign=342122E84F0BD86BF217F1A46942D79D&userId=1b448be323&channelId=2094979&timestamp=1634264231586
```

### 响应参数描述

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

#### data字段描述

| 参数名   | 类型     | 说明               |
| ----- | ------ | ---------------- |
| token | String | 调用接口token， 5小时有效 |

### Java请求示例

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

```java
/**
 * 获取观众观看调用接口token
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetWatchApiToken() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/watch/get-watch-api-token";
    String channelId = "2094979";
    String viewerId = "test1234";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("userId", userId);
    requestMap.put("viewerId", viewerId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试获取观众观看调用接口token，返回值：{}", response);
    //do somethings
    
}
```

### 响应示例

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

成功示例

```json
{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "token": "fri7txjyy1"
    }
}
```

异常示例

```json
{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
```