Set Subchannel Single Sign-On Token

Updated: 2022-09-02 18:08:07

API Description

1、设置子频道单点登录的token
2、该接口在单点登录后台使用场景中配合使用，仅可进入助教页面，具体查看单点登录文档
3、接口URL中的{accountId}为助教角色号
4、接口支持https协议

API URL

http://api.polyv.net/live/v2/channels/{accountId}/set-account-token

Online API Call

Request Method

POST

API Constraints

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

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` See Signature Generation Rules
token	true	String	A unique string. Do not make it too simple; a 16-character random string is recommended. The set token string is valid for 10 seconds and for one-time verification only. See Single Sign-On Documentation

Example

http://api.polyv.net/live/v2/channels/0052191541/set-account-token

Form Parameters:

appId=frlr1zazn3&sign=53E3A76ACF57F195173AAE78252798D4&timestamp=1621840435176&token=6612346dc89c4fdab7a3e0d335fb701b

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure. See Global Error Description
status	String	Response status text
message	String	Response description. When code is 400 or 500, it provides additional error details.
data	String	Returns "success" on success, empty string on failure.

Java Request Example

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 设置子频道单点登录token
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testSetAccountToken() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v2/channels/%s/set-account-token";
    String account = "0062149710";
    String token = LiveSignUtil.generateUUID();
    
    url = String.format(url, account);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("token", token);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试设置子频道单点登录token，返回值：{}", response);
    //do somethings
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "success"
}

Error Example

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

Live Streaming Server API