保利威文档中心

幫助中心

分頁查詢商品

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

介面描述

1、分页查询标签
2、接口支持https协议

介面URL

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

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

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

範例

https://api.polyv.net/live/v4/user/product/list?appId=frlr1zazn3&timestamp=1670471250000&sign=149397BFD607C518A841DAF8777D6A7E&pageNumber=1&pageSize=10

回應參數描述

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

Error參數描述

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

data參數描述

參數名 類型 說明
pageNumber String 分頁頁碼
pageSize Integer 分頁大小
totalPages String 總頁數
totalItems String 總記錄數
contents Array 商品陣列
contents參數描述
參數名 類型 說明
productId String 商品id
name String 商品名稱
cover String 封面圖, normal類型商品值不為空
linkType Integer 商品連結類型, 10:通用連結,11:多平台連結 ,12:呼叫原生方法
link String 商品連結不能為空
productType String 商品類型,可能的值有:
normal: 一般商品
finance: 金融商品
position:職位商品
pcLink String pc端連結
mobileLink String 行動端連結
wxMiniprogramOriginalId String 微信小程式原始ID
wxMiniprogramLink String 微信小程式連結
mobileAppLink String 手機APP連結
iosLink String ios連結
androidLink String android連結
otherLink String 其他端連結
features String 商品特色,賣點標籤,可以多個,json陣列
tagIds Array 商品標籤ID列表
btnShow String 按鈕顯示文案
productDesc String 商品描述
productDetail String 商品詳情,返回的是個內容存放的地址:例如 https://liveimages.videocc.net/product-info/product-detail/4d57ea01de/704007d1fdfd4cb2a5b3d3a842418831.json url存放的就是商品詳情內容
ext String 擴充資訊:JSON物件字串:{"coverList":["封面圖地址,最多15個"], "videoList":[{"videoSource":"影片來源", "videoId":"影片ID"}]} 【詳情見EXT
- - 以下為一般商品專用參數 (productType=normal)
priceType String 商品實際價格類型,可能的值有:
AMOUNT: 金額
CUSTOM: 自訂
realPrice Float 商品實際價格-金額,最高精確度為兩位小數,如 12.34
customPrice String 商品實際價格-自訂
originalPriceType String 商品原始價格(劃線價格)類型,可能的值有:
AMOUNT: 金額
CUSTOM: 自訂
price Float 商品原始價格(劃線價格)-金額,最高精確度為兩位小數,如 12.34
customOrignalPrice String 商品原始價格(劃線價格)-自訂備註:如果 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-素材庫

商品詳情productDetail url裡存放內容範例

{
"productDetail": "<p>这是商品详情</p>"
}

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 getProductPageTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    Integer pageNumber = 1;
    Integer pageSize = 10;
    //业务参数
    String url = "https://api.polyv.net/live/v4/user/product/list";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("pageNumber", pageNumber);
    requestMap.put("pageSize", pageSize);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询商品分页成功:{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "9ccd6f6e-cf35-4d9e-8a0c-0fa9d214c592",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 1,
        "contents": [
            {
                "productId": "1729060628513820672",
                "name": "123",
                "price": 0,
                "cover": "//liveimages.videocc.net/uploaded/images/2023/11/gqzb4tybhf.jpg",
                "link": "http://123.456.com",
                "rank": 1,
                "realPrice": 0,
                "type": "demo",
                "linkType": 10,
                "pcLink": "",
                "mobileLink": "",
                "androidLink": "",
                "iosLink": "",
                "otherLink": "",
                "wxMiniprogramLink": "",
                "wxMiniprogramOriginalId": "",
                "mobileAppLink": "",
                "params": null,
                "productType": "normal",
                "btnShow": null,
                "features": "[\"\", \"\"]",
                "tagIds": [1001, 1002],
                "productDesc": "",
                "productDetail": "https://liveimages.videocc.net/product-info/product-detail/4d57ea01de/704007d1fdfd4cb2a5b3d3a842418831.json",
                "yield": null
            }
        ]
    },
    "success": true
}

異常範例

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