Set Live Sub-Account SSO Token

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

API Description

1、设置直播子账号单点登录的token
2、token参数请勿过于简单，建议使用16位随机字符串
3、token设置后需要10秒内及时使用
4、接口支持https协议

API URL

http://api.polyv.net/live/v3/user/set-sso-token

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameters

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 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	Unique string
childEmail	true	String	Email account of the live sub-account

Example

http://api.polyv.net/live/v3/user/set-sso-token

Form Parameters:

appId=frlr1zazn3&sign=DE7CB3024B1C1D844031D77B774F4E38&timestamp=1621840259733&token=111&childEmail=xxx@polyv.net

Response Parameters

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, provides additional error details
data	String	Returns "success" on success, empty string on failure

Java Request Example

For quick integration, download the relevant dependency source code. Click to download source code. After downloading, add it to your own 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 pools.

private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
 /**
     * 设置直播子账号单点登录token
     * @throws IOException
     * @throws NoSuchAlgorithmException
     */
    @Test
    public void testSetUserLoginToken() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际
        String appId = super.appId;
        String appSecret = super.appSecret;
        String userId = super.userId;
        String childEmail = super.childEmail;
        String timestamp = String.valueOf(System.currentTimeMillis());
        //业务参数
        String url = "https://api.polyv.net/live/v3/user/set-sso-token";
        String token="111";

        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("childEmail", childEmail);
        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 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