通过关键词搜索节目

1. 接口描述

URL https://openapi.youku.com/router/rest.json
功能描述 通过关键词搜节目
返回格式 Json,UTF8
HTTP请求方式 GET
当前接口版本 V3
历史接口版本 V2

2. 系统参数

参数名 参数全称 必选 参数类型 参数描述
action action true String youku.search.program.keyword.get
client_id client_id true String 应用的client id
access_token access token false String oauth2的token
format format false String 可选,指定响应格式。默认保持代理接口格式化,目前支持格式为xml,json,text
timestamp timestamp true String 客户端当前时间戳,精确到秒,timestamp与开放平台请求时间误差为6分钟
version version true String 3.0
sign sign true String 对API调用参数(除sign外)的md5加密值。详情见签名方法

3. 业务参数

参数名 参数类型 必选 参数默认值 参数描述
keyword string true 搜索关键字
cateId int false 搜节目cateId=7
searchType int false 1 搜索类型,同pc上的切换站点,1=全网、2=优酷、3=土豆
allowfilter int false 1 是否有版权显示,0:不显示,1:显示
sourceSite int false 播放站点,多个站点以逗号分割,过滤掉某个站点加!,排除搜狐和凤凰网
streamType string false 节目流格式:flv,flvhd,hd,3gp,rtmp,3gphd,hd2
areaCode int false 节目地区,多个地区用逗号分隔,如:area=1,2。具体见注意事项部分。
videoType int false 节目播放地址类型:1(正片),2(预告片),3(花絮)
releaseDate date false 上映时间,如:2013年1月1日到2013年6月30日之间上映的节目 releaseDate=20130101,20130630
pay int false 是否付费,0免费,1付费
payType int false 付费类型,1=点播,10=包月,100=即能点播又能包月
head int false 取播放列表前head集
tail int false 取播放列表后tail集
device int false 调用设备,1=Mobile,2=PC,3=Pad,4=TV 默认为2=PC
isApple int false 是否是苹果设备,1=是,2=否 默认为2=否
ip string false 用户真实的ip地址
noqc int false 0 默认纠错,noqc=1不进行纠错,其他值进行纠错

4. 返回参数

参数名 参数全称 必选 参数类型 参数描述
total total false String 节目总数
title title false string 搜索关键字
showBigwordCate showBigwordCate false string 节目大词
shows shows true object 节目对象
genre genre true string 类型
showid showid true string 节目ID
zhengPian zhengPian true string
score score true float 评分
commentsCount commentsCount true int 评论数
releaseYear releaseYear true string 上线年份
trailerUrl trailerUrl true int 预告片地址
sortmode sortmode true int 节目技术
tvGuide tvGuide true string 电视引导 (电视剧,电影,综艺,教育,纪录片)
hasTudou hasTudou true int tudou是否有资源
peripheryVideo peripheryVideo false object 优酷预告片和花絮
tudouArea tudouArea false object
tudouPlayUrl tudouPlayUrl true string 土豆播放地址
hd hd true int 高清标记
copyright copyright true int 版权状态 0=版权未知,1=已授权,2= 版权,3=版权过期,4=公共版权,5=伪授权
showState showState true string 节目状态
director director true string 导演
tudouTotalvv tudouTotalvv true string 土豆总播放数
detailUrlYouku detailUrlYouku true string 优酷详情页地址
payType payType true int 付费类型,1=点播,10=包月,100=即能点播又能包月
detailUrlTudou detailUrlTudou true string 土豆详情页地址
performer performer true string 演员
totalvv totalvv true int 总播放数
detailUrlSoku detailUrlSoku true string 搜酷详情页地址
weekvv weekvv true int 周播放数
episodeType episodeType true string 播放连接的类型,1代表版权剧连接,2代表用户上传连接
playurl playurl true string 土豆播放地址
streamTypes streamTypes true string 视频流理性
tudouPeripheryVideo tudouPeripheryVideo false object 土豆预告片和花絮
youkuPlayUrl youkuPlayUrl true string youku播放地址
deviceDisabled deviceDisabled false string 禁播终端
paid paid true int 是否付费
area area false string 地区
releaseDate releaseDate true int 上线时间
displaystatus displaystatus false string 图片腰封
tudouId tudouId true int 土豆视频ID
tudouGenre tudouGenre false string 土豆分类
episodeTotal episodeTotal true int 总集数,更新中的不确定有多少剧集该字段为0
name name false string 名称
programmeId programmeId true int 节目ID
hasYouku hasYouku false int 优酷是否有该片
completed completed true int 是否完结
site site false int 站点数
alias alias true string[] 别名列表
tudouPoint tudouPoint false string[]
tudouPaid tudouPaid true int 土豆是否付费
pic pic false string 海报
vpic vpic true string 竖图海报
animeEdition animeEdition false string 动画版本
defSite defSite true int 缺省上线站点
source source false string 节目来源站点
subtitle subtitle true string 副标题
allowfilter allowfilter false string 是否有版权显示
overseasReleaseDate overseasReleaseDate true int 海外上线时间
peripheryCount peripheryCount false int 周边视频个数
cateId cateId true int 直达区分类id
brief brief false string 简介
updateNotice updateNotice true string 更新通知

5. 调用示例

https://openapi.youku.com/router/rest.json?caller=NOVA&opensysparams={
"sign": "3bd78183cc303aeee0ce5403b201b0a4", "action": 
"youku.search.program.keyword.get", "timestamp": 1453720478, "format": "json",
"version": "3.0", "client_id": "163d4fd10c7f9a28", "access_token": 
"d9ce66ced641240836cf6011a4c195bc"}&keyword=刘德华全部电影
                  

6. 响应示例

{
    "total": 128,
    "keyword": "刘德华全部电影",
    "showBigwordCate": 2, //2=节目大词
    "shows": [ //节目对象
        {
            "genre": [],
            "showid": "cc02c0c6962411de83b1",
            "zhengPian": "b,c",
            "score": 7.23199987411499,
            "commentsCount": 88,
            "releaseYear": "2001",
            "trailerUrl": "",
            "sortmode": 0,
            "tvGuide": [ ],
            "hasTudou": 1,
            "peripheryVideo": [],
            "tudouArea": [],
            "tudouPlayUrl": "http://www.tudou.com/albumplay/5S9djju1IHs/-oyTkWkUBcs.html",
            "hd": 0,
            "copyright": 0,
            "showState": "normal",
            "director": [],
            "tudouTotalvv": 476911,
            "detailUrlYouku": "http://www.youku.com/show_page/id_zcc02c0c6962411de83b1.html",
            "payType": 0,
            "detailUrlTudou": "http://www.tudou.com/albumcover/5S9djju1IHs.html",
            "performer": [],
            "totalvv": 769151,
            "detailUrlSoku": "/detail/show/XOTQ1NjA=",
            "weekvv": 30077,
            "episodeType": 1,
            "playurl": "http://www.tudou.com/albumplay/5S9djju1IHs/-oyTkWkUBcs.html",
            "streamTypes": "flv",
            "tudouPeripheryVideo": [],
            "youkuPlayUrl": "http://v.youku.com/v_show/id_XMTQ1Mzc2ODA0.html",
            "deviceDisabled": "",
            "paid": 0,
            "area": [],
            "releaseDate": "2001-08-03",
            "displaystatus": "正片",
            "tudouId": 98560,
            "tudouGenre": [],
            "episodeTotal": 1,
            "name": "全职杀手",
            "programmeId": 23640,
            "hasYouku": 1,
            "completed": 1,
            "site": 3,
            "alias": [],
            "tudouPoint": [ ],
            "tudouPaid": 0,
            "pic": "http://g2.ykimg.com/050B000052BA54E06758392BE509C2A8",
            "vpic": "http://g2.ykimg.com/0516000052BA54EC67583974DB0E5C4B",
            "animeEdition": "0",
            "defSite": 1,
            "source": "土豆网",
            "subtitle": "反町隆史人气杀手王",
            "allowfilter": 1,
            "overseasReleaseDate": "2001-08-03",
            "peripheryCount": 0,
            "cateId": 2,
            "brief": "至爱死后,杀手O(反町隆史 饰)在一个安全隐蔽的住所将自己完全封闭了起来",
            "updateNotice": ""
        },
        {}
    ],
    cateId: 7 
}
                  

7. 异常示例

8. 注意事项

(1)请预留“X-Caller”和“User-Agent”段以标识调用方名称和调用方平台请设置“Accept-Encoding: gzip, deflate”段以打开gzip压缩,并且调用方需要支持gzip解压缩如果调用方不是请求的发起方而是代理方,请设置“X-Forwarded-For”记录发起方的真实IP Referer、Cookie等段可选,建议代理方能够尽量多的带上调用方的相关信息,以便服务方分析用户行为。

(2)地区代码

1 美国 2  西班牙 3  墨西哥 4  大陆 5  比利时 6  新加坡 7  德国 8  加拿大 9  澳大利亚 10 英国 
11 意大利 12 香港 13 俄罗斯14 瑞典 15 挪威 16 荷兰 17 新西兰 18 南非 19 韩国 20 保加利亚
21 以色列 22 法国 23 克罗地亚 24 其他 25 波兰 26 日本 27 印度 28 芬兰 29 葡萄牙 30 台湾 
31 埃及 32 丹麦 33 泰国 34 菲律宾 35 澳门 36 马来西亚 37 罗马尼亚 38 阿根廷 39 巴西 40 卢森堡 
41 爱尔兰 42 瑞士 43 印度尼西亚 44 越南 45 希腊 46 智利 47 奥地利 48 匈牙利 49 波黑 50 古巴 
51 格鲁吉亚 52 马其顿 53 朝鲜 54 土耳其 55 巴拉圭 56 巴勒斯坦 57 捷克 58 伊朗 59 冰岛 60 南斯拉夫 
61 乌拉圭 62 蒙古 63 秘鲁 64 柬埔寨 65 尼日利亚 66 黎巴嫩 67 哥伦比亚 68 突尼斯 69 利比亚 70 苏格兰 
71 阿富汗 72 阿联酋