保利威文档中心

幫助中心

建立商品

更新時間:2026-07-13 11:28:48

介面說明

1、创建标签
2、接口支持https协议

介面URL

https://api.polyv.net/live/v4/user/product/save

線上API呼叫

請求方式

POST

介面限制

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

請求參數說明

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

請求體參數說明

參數名 必填 類型 說明
name true String 商品名稱
cover false String 封面圖,normal類型商品值不為空
linkType true Integer 商品連結類型,10:通用連結,11:多平台連結,12:呼叫原生方法
link true String 商品連結不能為空
productType false String 商品類型,可選值有:
normal: 一般商品
finance: 金融商品
position:職位商品
不傳時預設為 normal
pcLink false String pc端連結
mobileLink false String 行動端連結
wxMiniprogramOriginalId false String 微信小程式原始ID
wxMiniprogramLink false String 微信小程式連結
mobileAppLink false String 手機APP連結
iosLink false String ios連結
androidLink false String android連結
otherLink false String 其他端連結
features false String 商品特色,賣點標籤,可以多個,json陣列
tagIds false Array 商品標籤ID列表
btnShow false String 按鈕顯示文字
productDesc false String 商品描述
productDetail false String 商品詳情
ext false String 擴充資訊:JSON物件字串:{"coverList":["封面圖地址,最多15個"], "videoList":[{"videoSource":"影片來源", "videoId":"影片ID"}]} 【詳情見EXT】cover和ext選擇其中一個欄位傳,如果同時傳以ext為準
- - - 以下為一般商品專用參數 (productType=normal)
priceType false String 商品實際價格類型,可選值有:
AMOUNT: 金額
CUSTOM: 自訂
不傳時預設為 AMOUNT
realPrice false Float 商品實際價格-金額,priceType=AMOUNT 時必填,最高精確度為兩位小數,如 12.34
customPrice false String 商品實際價格-自訂,priceType=CUSTOM 時必填,最多20個字元
originalPriceType false String 商品原始價格(劃線價格)類型,可選值有:
AMOUNT: 金額
CUSTOM: 自訂
預設為 AMOUNT
price false Float 商品原始價格(劃線價格)-金額,originalPriceType=AMOUNT 時生效,最高精確度為兩位小數,如 12.34
customOrignalPrice false String 商品原始價格(劃線價格)-自訂,originalPriceType=CUSTOM 時生效,最多20個字元
備註:如果 price 和 customOriginalPrice 都為空,則表示不啟用原始價格(劃線價格)
- - - 以上為一般商品專用參數 (productType=normal)

EXT

參數名 必填 類型 說明
coverList true Array 封面圖地址陣列,最多15個
videoList false Array 影片陣列,最多1個【詳情見ChannelProductExtVideo】需要開通素材庫才能使用
jumpWay false String 購買方式為外鏈購買-通用連結的跳轉方式:POP_UP-彈出框開啟、NEW_WINDOW-新視窗開啟、CURRENT_WINDOW-目前視窗開啟

ChannelProductExtVideo

參數名 必填 類型 說明
videoId true String 影片ID
videoSource true String 影片來源:MATERIAL_LIBRARY-素材庫

範例

https://api.polyv.net/live/v4/user/product/save?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

請求體json參數:

{
    "productType": "normal",
    "linkType": 10,
    "link": "http://123.456.com",
    "pcLink": "",
    "mobileLink": "",
    "wxMiniprogramOriginalId": "",
    "wxMiniprogramLink": "",
    "mobileAppLink": "",
    "iosLink": "",
    "androidLink": "",
    "otherLink": "",
    "cover": "//liveimages.videocc.net/uploaded/images/2023/11/gqzaoq7pk3.png",
    "name": "平台商品",
    "price": 0,
    "realPrice": 0,
    "features": "[\"\",\"\"]",
    "tagIds": [1001, 1002],
    "productDesc": "",
    "productDetail": ""
}

回應參數說明

參數名 類型 說明
code Integer 回應狀態碼,200為成功回傳,非200為失敗
status String 回應結果,由業務決定,成功回傳success,失敗回傳error
data String 成功時,內容為商品id
success Boolean 回應結果,由業務決定,成功回傳true,失敗回傳false
error Object 狀態碼非200時的錯誤資訊【詳見Error欄位說明
requestId String 請求ID,每次請求產生的唯一的UUID,僅可用於排查、除錯,不應該和業務掛鉤

Error參數說明

參數名 類型 說明
code Integer 錯誤代碼,用於確定具體的錯誤原因
desc String 錯誤描述,與 error.code 對應

Java請求範例

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

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

private final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 新增商品
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void createProductTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
        
    String url = "https://api.polyv.net/live/v4/user/product/save";
    //业务参数
    String name = "平台商品";
    String productType = "normal";
    Integer linkType = 10;
    String link = "http://123.456.com";
    String cover = "//liveimages.videocc.net/uploaded/images/2023/11/gqzaoq7pk3.png";
    
  
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("name", name);
    jsonMap.put("linkType", linkType);
    jsonMap.put("link", link);
    jsonMap.put("productType", productType);
    jsonMap.put("cover", cover);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    
    log.info("测试新建商品结果:{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "78de516b69364aeabe7d080e7228cc5c.77.16705507903976231",
    "data": null,
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服,在线咨询