查詢分類列表
更新時間:2022-09-02 18:08:07
介面描述
1、通过分类id分页查询分类列表
2、接口支持https协议
介面URL
http://api.polyv.net/v3/category/get
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 保利威點播子帳戶appId,取得路徑:保利威點播後台->設定->帳號管理 |
| timestamp | true | Long | 目前時間的毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值【詳見MD5簽名產生規則】 |
| cateId | true | Long | 分類id,預設為1則查詢所有分類列表 |
| page | false | Integer | 子分類列表頁碼 |
| pageSize | false | Integer | 子分類每頁大小 |
範例
http://api.polyv.net/v3/category/get
表單參數:
cateId=1608891483165&appId=a0Wmol5EwX&sign=2A0027CB75FEF9F24DD6B680A2FC20AE×tamp=1617935598256
響應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| requestId | String | 每次請求的業務流水號,必須唯一,便於客戶端/伺服器端排查問題 |
| code | Integer | 響應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 響應狀態文字資訊 |
| error | Object | 響應成功返回null,響應失敗返回錯誤描述資訊【詳見error參數描述】 |
| data | Object | 響應成功時返回分類列表資訊【詳見data欄位說明】 |
error參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 錯誤碼 |
| desc | String | 錯誤描述 |
data參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| category | Object | 目前分類資訊【詳見category欄位說明】 |
| subCategoryTotal | Integer | 下一級子分類個數 |
| subCategories | Array | 下一級子分類列表【詳見subCategories欄位說明】 |
category參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| cateId | Long | 分類id |
| cateName | String | 分類名稱 |
| parentId | Long | 上一級分類id |
subCategories參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| cateId | Long | 分類id |
| cateName | String | 分類名稱 |
| parentId | Long | 上一級分類id |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 VodSignUtil.java 都包含在下載檔案中。
強烈建議您使用點播Java SDK完成API的功能對接,點播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(VodSubAccountTest.class);
/**
* 查询分类列表
* @throws Exception
* @throws NoSuchAlgorithmException
*/
@Test
public void testSubGetCategories() throws Exception, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/v3/category/get";
String cateId = "1608891483165";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("cateId", cateId);
requestMap.put("sign", VodSignUtil.getSignMd5(requestMap, appSecret));
String response = HttpUtil.postFormBody(url, requestMap);
log.debug("测试查询分类列表,{}", response);
//do somethings
}
響應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"requestId":"52ec91c6-4b2e-487e-976c-03378d3035af",
"code":200,
"status":"success",
"error":null,
"data":{
"category":{
"cateId":1608891483165,
"cateName":"伪直播功能专用分类",
"parentId":1
},
"subCategoryTotal":7,
"subCategories":[
{
"cateId":1608891483169,
"cateName":"2070151",
"parentId":1608891483165
},
{
"cateId":1610069551999,
"cateName":"2087172",
"parentId":1608891483165
},
{
"cateId":1610605203885,
"cateName":"2095792",
"parentId":1608891483165
},
{
"cateId":1615344036891,
"cateName":"2149710",
"parentId":1608891483165
},
{
"cateId":1615357280260,
"cateName":"2149813",
"parentId":1608891483165
},
{
"cateId":1616053580583,
"cateName":"2205908",
"parentId":1608891483165
},
{
"cateId":1616572747765,
"cateName":"1958888",
"parentId":1608891483165
}
]
}
}
異常範例
時間戳錯誤
{
"requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
"code": 400,
"status": "error",
"error": {
"code": 100,
"desc": "invalid timestamp"
},
"data": null
}
appId不正確
{
"requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
"code": 400,
"status": "error",
"error": {
"code": 101,
"desc": "application not exist"
},
"data": null
}
子帳號不存在
{
"requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
"code": 400,
"status": "error",
"error": {
"code": 102,
"desc": "user children not exist"
},
"data": null
}
子帳號過期
{
"requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
"code": 403,
"status": "error",
"error": {
"code": 103,
"desc": "user children expired"
},
"data": null
}
簽名錯誤
{
"requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
"code": 403,
"status": "error",
"error": {
"code": 104,
"desc": "invalid signature"
},
"data": null
}
帳號權限不足
{
"requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
"code": 403,
"status": "error",
"error": {
"code": 105,
"desc": "permission limited"
},
"data": null
}
分類不存在
{
"requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
"code": 400,
"status": "error",
"error": {
"code": 3001,
"desc": "category not exist"
},
"data": null
}
