Modify Channel Product Library Switch Status

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

Interface Description

1、修改频道商品库开关状态，如果没有开启商品库权限请联系客服
2、接口支持https协议

Interface URL

http://api.polyv.net/live/v3/channel/product/update-enabled

Online API Call

Request Method

POST

Interface Constraints

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

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details for obtaining secret key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 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 saved or used directly on the client side. All APIs must be relayed through the customer's own server to call the POLYV server for response data.` See details for signature generation rules
channelId	true	String	Channel ID
enabled	true	String	Switch status Y: Enable N: Disable

Example

http://api.polyv.net/live/v3/channel/product/update-enabled

Form Parameters:

appId=frlr1zazn3&sign=E10F04266727F4960848228059788FE2&channelId=2191569&enabled=Y&timestamp=1621843540123

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See details for global error description
status	String	Response status text
message	String	Response description message, auxiliary error reason when code is 400 or 500
data	String	Returns "SUCCESS" string on success, empty string on failure

Java Request Example

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

It is strongly recommended to use the Live Java SDK for API functionality 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(ChannelOperateTest.class);
/**
 * 修改频道商品库开关状态
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testUpdateChannelProductEnabled() 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/product/update-enabled";
    String channelId="2191569";
    String enabled="Y";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("enabled", enabled);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url,requestMap);
    log.info("测试修改频道商品库开关状态，返回值：{}", response);
    //do somethings

}

Response Example

See Global Error Description for system-wide error descriptions.

Success Example

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

Error Example

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