zhaogd/as-daycard-openapi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

更新橘视厅酒店版openapi文档

Browse Source 
- 媒资接口补充 /list 多栏目查询、/list-all 全量聚合、/episodes 分集查询接口说明
- curl 示例补充对应接口调用示例，调整章节编号
This commit is contained in:
zhaogd
2026-07-29 12:19:05 +08:00
parent 221decc070
commit 73d0d42e8f
1 changed files with 66 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
橘视厅酒店版openapi文档.md
View File

@@ -210,15 +210,55 @@ GET /openapi/partner/media/list?catalogid=472&pageindex=1&pagesize=20
| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| catalogid | String | FULL/CATALOG 级别必填 | 栏目 ID |
| catalogid | String | FULL/CATALOG 级别必填 | 栏目 ID，支持逗号分隔传多个（如 `472,492,494`）|
| pageindex | int | 否（默认 1）| 页码 |
| pagesize | int | 否（默认 20）| 每页条数 |
- CONTENT 级别：返回授权内容列表，不需传 catalogid
- CATALOG 级别：必须传授权范围内的 catalogid
- CATALOG 级别：必须传授权范围内的 catalogid（多栏目时每个都需在授权范围内）
- FULL 级别：必须传 catalogid
- 单栏目：走橘视厅原生分页，响应快
- 多栏目（逗号分隔）：聚合各栏目全量内容后本地分页
### 4.4 搜索
### 4.4 全量内容列表
```
GET /openapi/partner/media/list-all?parentCatalogid=471
```
一次请求返回某一级栏目（如 471 电影）下所有二级栏目合并后的全部内容，不分页。适合按天低频全量同步。
| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| parentCatalogid | String | 否（默认 471）| 一级栏目 ID |
> 注：各二级栏目内容可能有跨栏目重复（一条内容可属多个栏目），第三方自行按 contentcode 去重。
### 4.5 分集列表
```
GET /openapi/partner/media/episodes?contentcode=23010012026061709581101832&pageindex=1&pagesize=20
```
传入电视剧的父级 contentcode，返回其下各分集列表。分集的 contentcode 可作为 programCode 传入 SDK 获取播放地址。
| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| contentcode | String | 是 | 父级内容编码（电视剧的 contentcode）|
| pageindex | int | 否（默认 1）| 页码 |
| pagesize | int | 否（默认 20）| 每页条数 |
- CONTENT 级别：校验 contentcode 在授权范围内
- CATALOG/FULL 级别：直接返回
分集额外字段：
| 字段 | 说明 |
|------|------|
| episodeindex | 集数索引，排序用 |
| parentContentType | 内容类型 |
### 4.6 搜索
```
GET /openapi/partner/media/search?keyword=镖人&pageindex=1&pagesize=20
@@ -230,7 +270,7 @@ GET /openapi/partner/media/search?keyword=镖人&pageindex=1&pagesize=20
| pageindex | int | 否（默认 1）| 页码 |
| pagesize | int | 否（默认 20）| 每页条数 |
### 4.5 内容字段说明
### 4.7 内容字段说明
| 字段 | 说明 |
|------|------|
@@ -403,7 +443,27 @@ curl -X GET "http://58.220.83.58:8084/openapi/partner/media/list?catalogid=472&p
-H "sign: A6EBB96858ED2FAD864CB39568E3EABB"
```
### 7.6 搜索
### 7.6 全量内容列表
```bash
curl -X GET "http://58.220.83.58:8084/openapi/partner/media/list-all?parentCatalogid=471" \
-H "appKey: 你的appKey" \
-H "timestamp: 1784809605695" \
-H "nonce: 1784809605695aaf094ef" \
-H "sign: A6EBB96858ED2FAD864CB39568E3EABB"
```
### 7.7 分集列表
```bash
curl -X GET "http://58.220.83.58:8084/openapi/partner/media/episodes?contentcode=23010012026061709581101832&pageindex=1&pagesize=20" \
-H "appKey: 你的appKey" \
-H "timestamp: 1784809605695" \
-H "nonce: 1784809605695aaf094ef" \
-H "sign: A6EBB96858ED2FAD864CB39568E3EABB"
```
### 7.8 搜索
```bash
curl -X GET "http://58.220.83.58:8084/openapi/partner/media/search?keyword=镖人&pageindex=1&pagesize=20" \
@@ -413,7 +473,7 @@ curl -X GET "http://58.220.83.58:8084/openapi/partner/media/search?keyword=镖
-H "sign: A6EBB96858ED2FAD864CB39568E3EABB"
```
### 7.7 签名生成示例（bash）
### 7.9 签名生成示例（bash）
```bash
APP_KEY="你的appKey"