X直播新版API文档
X直播 App API 接口
接口修改说明
| 日期 | 修改人 |
|---|---|
| 2015/11/30 | 王小柱 |
目录
[TOC]
接口文档概要说明
- 文档是《X直播平台接口通讯协议》的补充版本， 旨在快速定义相关接口
- 系统接口使用http作为承载协议，使用HTTP GET 请求；传递参数为URL UTF-8编码，返回结果为UTF-8编码
- 加密Sig为32位MD5数字签名大写字符串
- 接口加密方式照旧
- 接口返回参数为json格式
- 接口地址由接口url与调用method确定唯一性
- 所有接口请求头中将加入参数
Channel: 渠道version: 版本号Device-Id: 设备号platform: 平台 android/iosuser: 用户id 可能会为空 - 所有接口传入的默认参数为
-
method方法名 -
name调用用户 -
password调用密码 -
meid设备号 -
timestamp时间戳 -
sig加密串
-
- 所有接口参数拼接加密后 使用
http:\\xxxx:port/com/xxx.action?paramStr=加密串方式请求服务器
API LIST
1、首页推介接口
| url | method |
| ----------|-------------------------------:|
| http://ip:port/interface/user/xxx.action | method|
首页接口，包括首页推荐列表和直播条信息
请求参数
-
user_id: 用户id
返回参数
-
errorcode00 成功 -
msg服务器提示信息 -
recData: 首页推荐信息（直播条）,列表id-
type: 类型0: 视频1: 音频2: 文章3: 专题 -
tag: 标签，界面显示的红色文字标签 -
title: 标题 -
desc: 描述
- vidData 视频信息，列表
-
title: 标题 -
id: 可以根据id获取对应的列表 -
vids视频列表id-
channelType: 类型0: 视频1: 音频2: 文章3: 专题 -
img: 预览图 -
title: 标题 -
view: 点击量 -
comments评论数
-
{
"errorcode": 0,
"msg": "提示",
"recData": [
{
"id": 1231231232,
"type": 3,
"tag": "直播",
"desc": "描述",
"title": "标题"
},
{
"id": 1231231232,
"type": 3,
"tag": "直播",
"desc": "描述",
"title": "标题"
}
],
"vidData": [
{
"title": "附近人都在看",
"id": "列表id",
"vids": [
{
"id": 23142341,
"title": "真娘子",
"channelType": 2,
"img": "http:\\sssss.jpg",
"url": "播放地址",
"view": "12421 播放次数",
"comments": "1234评论次数"
},
{
"id": 23142341,
"title": "真娘子",
"channelType": 2,
"img": "http:\\sssss.jpg",
"url": "播放地址",
"view": "12421 播放次数",
"comments": "1234评论次数"
}
]
},
{
"title": "最近热播",
"id": "列表id",
"vids": [
{
"id": 23142341,
"title": "真娘子",
"channelType": 2,
"img": "http:\\sssss.jpg",
"url": "播放地址",
"view": "12421 播放次数",
"comments": "1234评论次数"
},
{
"id": 23142341,
"title": "真娘子",
"channelType": 2,
"img": "http:\\sssss.jpg",
"url": "播放地址",
"view": "12421 播放次数",
"comments": "1234评论次数"
}
]
}
]
}
2、首页电视接口
| url | method |
| ----------|-------------------------------:|
| http://ip:port/interface/user/xxx.action | method|
首页的电视列表页
请求参数
无
返回参数
-
errorcode00 成功 msg-
data分类列表id-
programImg当前节目图片 -
title电视台名称 -
program当前节目 -
timeTag时间安排， 如直播时间 10:26-20:00或者每周五 10:26-20:00 -
fan当前观看人数
{
"errorcode": 0,
"msg": "提示",
"data": [
{
"id": "dafdasdf",
"programImg": "xxx.jsg",
"title": "CCTV5",
"program": "动物世界",
"timeTag": "直播时间 10:26-20:00",
"fan": 342451
},
{
"id": "dafdasdf",
"programImg": "xxx.jsg",
"title": "CCTV8",
"program": "金瓶梅",
"timeTag": "直播时间 18:26-22:00",
"fan": 324511
}
]
}
3、首页电台接口
| url | method |
| ----------|-------------------------------:|
| http://ip:port/interface/user/xxx.action | method|
首页的电台的列表接口，需要 返回历史收听记录和所有的电台
请求参数
无
返回参数
-
errorcode00 成功 msg-
data分类列表id-
programImg当前节目图片 -
title电视台名称 -
program当前节目 -
timeTag时间安排， 如直播时间 10:26-20:00或者每周五 10:26-20:00 -
fan当前观看人数
-
hotData热门电台id-
title电台名称 -
img电台图片 -
fan当前观看人数
-
historyData最近收听id-
title电台名称 -
logo电台小图logo -
fan当前观看人数
{
"errorcode": 0,
"msg": "提示",
"data": [
{
"id": "dafdasdf",
"programImg": "xxx.jsg",
"title": "fn 987",
"program": "动物世界",
"timeTag": "直播时间 10:26-20:00",
"fan": 342451
},
{
"id": "dafdasdf",
"programImg": "xxx.jsg",
"title": "FM 451",
"program": "金瓶梅",
"timeTag": "直播时间 18:26-22:00",
"fan": 324511
}
],
"hotData": [
{
"id": "dafdasdf",
"img": "xxx.jsg",
"title": "FM 451",
"fan": 324511
},
{
"id": "dafdasdf",
"img": "xxx.jsg",
"title": "FM 451",
"fan": 324511
}
],
"historyData": [
{
"id": "dafdasdf",
"logo": "xxx.jsg",
"title": "FM 451",
"fan": 324511
},
{
"id": "dafdasdf",
"logo": "xxx.jsg",
"title": "FM 451",
"fan": 324511
}
]
}
4、首页活动接口
| url | method |
| ----------|-------------------------------:|
| http://ip:port/interface/user/xxx.action | method|
首页的活动列表接口
请求参数
无
返回参数
-
errorcode00 成功 msg-
data分类列表id-
img活动图片 -
title活动名称 -
desc活动的介绍、摘要 -
timeTag时间安排， 如活动时间 10:26-20:00或者报名截止日期： 10:26-20:00 -
fan当前参与人数
{
"errorcode": 0,
"msg": "提示",
"data": [
{
"id": "dafdasdf",
"desc": "武汉晚报讯（记者万勤）夫妻俩协议离婚后，为争夺儿子的抚养权两人对簿公堂，女方说儿子非男方亲生，经亲子鉴定竟真的如此，男方一怒之下索赔50万。",
"title": "夫妻离婚争抚养权发现儿子非亲生 男子索赔50万",
"timeTag": "直播时间 10:26-20:00",
"fan": 342451,
"img": "活动图片"
}
]
}
5、点播分类首页接口
| url | method |
| ----------|-------------------------------:|
| http://ip:port/interface/user/xxx.action | method|
点播分类接口展示点播界面的分类，点击根据分类id能够进入响应的分类
请求参数
无
返回参数
-
errorcode00 成功 msg-
data分类列表id-
img图标 -
title标题 -
subData次级栏目信息-
id可以通过列表接口 title
-
{
"errorcode": 0,
"msg": "提示",
"data": [
{
"id": "dafdasdf",
"img": "xxx.jsg",
"title": "体育",
"subData": [
{
"id": "l",
"title": "精选"
},
{
"id": 2,
"title": "热门"
}
]
},
{
"id": "dafdasdf",
"img": "xxx.jsg",
"title": "经济",
"subData": [
{
"id": "l",
"title": "精选"
},
{
"id": 2,
"title": "热门"
}
]
}
]
}
