保利威文档中心

幫助中心

批次刪除頻道商品

更新時間:2024-09-11 11:45:04

介面描述

1、批量删除频道商品
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/product/batch-delete

線上API呼叫

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看

請求參數描述

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 當前13位毫秒級時間戳,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,生成簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁保存在客戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名生成規則
channelId true String 頻道號

請求體參數描述

參數名 必選 類型 說明
productIds true Array 頻道商品ID陣列,每次最多傳100個商品ID

範例

http://api.polyv.net/live/v3/channel/product/batch-delete

表單參數:

appId=frlr1zazn3&sign=5D39E63FC79E676980293E0D3A54B031&channelId=1965681&timestamp=1621843574601

請求體參數:

{
    "productIds":[12,123,444]
}

回應參數描述

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data String 請求成功時返回SUCCESS,請求失敗時為空

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log=LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 批量删除商品
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testBatchDeleteChannelProduct() 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/batch-delete";

        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);
        requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
        requestMap.put("channelId", "123333");
        url = HttpUtil.appendUrl(url, requestMap);
        
        String json = "{\"productIds\":[1,2,3,4]}";
        String response = HttpUtil.postJsonBody(url, json, null);
        log.info("测试批量删除商品,返回值:{}", response);
    
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

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

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
{
  "code": 400,
  "status": "error",
  "message": "param should not be empty: productIds",
  "data": ""
}
{
  "code": 400,
  "status": "error",
  "message": "批量操作的商品数量超过上限",
  "data": ""
}
{
  "code": 400,
  "status": "error",
  "message": "channel product sort type error",
  "data": ""
}
联系客服,在线咨询