Modify Channel External Authorization Settings

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

API Description

1、设置直播外部授权
2、接口URL中的{userId}为直播账号ID
3、接口支持https协议

API URL

http://api.polyv.net/live/v2/channelSetting/{userId}/auth-external

Online API Call

Request Method

POST

API Constraints

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

Request Parameters Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details: 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 the customer's own server to relay requests to the POLYV server for response data.` See details: Signature Generation Rules
externalUri	true	String	User info retrieval API endpoint
channelId	false	String	Channel ID. If submitted, sets the authorization for that specific channel. If not submitted or set to 0, the setting applies to all channels under the account.

Example

http://api.polyv.net/live/v2/channelSetting/1b448be323/auth-external

Form Parameters:

externalUri=http%3A%2F%2Fmywebsite.com%2FmyDefinedUrl.php&appId=frlr1zazn3&sign=DEE6DE2243713A95B41CF287C4AFB8FB&channelId=2191532&timestamp=1621843783712

Response Parameters Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure See details: Global Error Description
status	String	Response status text
message	String	Response description. When code is 400 or 500, provides additional error details
data	Array	On success, contains authorization info; on failure, an empty string See details: data field description

data Field Description

Parameter	Type	Description
channelId	String	The configured channel ID
secretKey	String	The secretKey for external authorization corresponding to the channel ID

Java Request Example

For quick integration, 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 package.

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(WatchConditionTest.class);
/**
 * 修改频道外部授权设置
 * @throws IOException
 */
@Test
public void testSetExternalauth() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/live/v2/channelSetting/%s/auth-external",userId);
    String channelId = "2191532";
    String externalUri = "http://mywebsite.com/myDefinedUrl.php";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);

    requestMap.put("channelId",channelId);
    requestMap.put("externalUri",externalUri);


    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改频道外部授权设置接口返回值：{}",response);
    //do somethings

}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [{
        "channelId": 2191532,
        "secretKey": "w5885oc72o"
    }]
}

Error Example

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