Cancel Push Channel Product Library Product

Updated: 2024-12-10 17:18:07

Interface Description

1、取消推送频道商品库商品
2、接口支持https协议

Interface URL

http://api.polyv.net/live/v3/channel/product/cancel-push-product

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 information for communication data security. It must not be saved on the client side for direct use. 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
productId	true	Integer	Product productId

Example

http://api.polyv.net/live/v3/channel/product/cancel-push-product

Form Parameters:

productId=29426&appId=frlr1zazn3&sign=25B1C55EA9B53C8BBD7D835A9CAF8B3B&channelId=1965681&timestamp=1621843461972

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for successful return, non-200 for failure See details for global error description
status	String	Response status text information
message	String	Response description information, assists in describing error reasons when code is 400 or 500
data	String	Returns null on successful response, returns empty string on failure

Java Request Example

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 推送商品库商品
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testCancelPushChannelProduct() 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/cancel-push-product";
    String channelId="1965681";
    String productId="29426";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("productId", productId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url,requestMap);
    log.info("测试取消推送商品库商品，返回值：{}", response);
    //do somethings

}

Response Example

For system global error descriptions, see Global Error Description

Successful Example

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

Error Example

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