api

来源：互联网发布：企业软件收费模式编辑：程序博客网时间：2024/06/03 22:00

数据请求说明：

大部分数据均由{"status":true,"code":0,"msg":"提示信息","data":{data}}
结构组成，列表数据由{"status":true,"data"{"pageCount":3,"total":"20","rows":[{},{},{}]}}结构组成，所有数据当status=false时返回的均包含msg字段，客户端可直接输出反馈给用户

服务器地址：http://****/

1、凭证获取接口

index.php?m=member&c=app2&a=start&device_id=gfdgdfg

接口地址中m=member&c=app2&a=start，为必传参数，除第一个start接口列外，其他所有接口均需要携带auth参数。

参数名称是否必须说明 device_id 是设备机器ID

返回示例如下：

{    "status": true,//返回成功    "code": 0,//暂时无用    "msg": "",    "data": {        "auth": "7a3aVFdbBFAJBwsMAgUBA1BYCwQCVgAGVVUAUwBQSgReAlEBBAVKAF1CWltQH1VI"//凭证信息，客户端需保存此参数,在下面接口中携带。    }}

2、栏目数据获取

index.php?m=member&c=app2&a=category&auth=d84eAQwAUVFWDFJbVlJTAlFSA1QDUVwBU18CW1sIT1ZfBgZUX14fBQZOCwEASAdJ

参数名称暂无可选参数

返回示例如下：

{    "status": true,    "code": 0,    "msg": "",    "data": {        "catergory": [ //栏目数据            {                "catid": "16",//栏目ID                "catname": "一席演讲",//栏目名称                "color": "#6236ab",//背景色                "image": "http://*********/uploadfile/2017/0412/20170412053509282.png"//首页图标,                "icon": "http://*********/uploadfile/2017/0412/20170412053522482.png"//列表页icon            }        ]    }}

3、获取视频列表

index.php?m=member&c=app2&a=listinfo&catid=5&auth=d84eAQwAUVFWDFJbVlJTAlFSA1QDUVwBU18CW1sIT1ZfBgZUX14fBQZOCwEASAdJ&

参数名称是否必须说明 catid 是栏目ID isFree 否可选参数为0,1,空，默认为空，即全部，1为免费，0为收费 page 否第几页，默认第1页 pageSize 否一页返回数据条数，默认一次返回10条

返回示例如下：

{    "status": true,    "code": 0,    "msg": "",    "data": {            "pageCount": 1,//总页数            "total": "3",//总条数            "rows": [                {                    "id": "3938",//视频专辑ID                    "title": "字曰书法",//名称                    "thumb": "http://************/uploadfile/2017/0415/20170415062137158.jpg"//图片,                    "catid": "11",//栏目id                    "money": 0//金额，免费为0                }            ]        }}

4、获取视频详情

index.php?m=member&c=app2&a=get&catid=5&id=3651&auth=d84eAQwAUVFWDFJbVlJTAlFSA1QDUVwBU18CW1sIT1ZfBgZUX14fBQZOCwEASAdJ

参数名称是否必须说明 catid 是栏目ID id 是视频id

返回示例如下：

{    "status": true,    "code": 0,    "msg": "",    "data": {            "id": "3651",  //专辑ID            "title": "食尚厨房", //专辑名字            "thumb": "http://r2.ykimg.com/0516000051930C27670C4A1AE00A0B29",//专辑图片            "hits": "7",//访问次数            "playCount": "32",//播放总集数            "updatedPlayCount": "32",/目前更新集数            "school": "",            "author":"",//作者,            "type": "",//类型            "isCollection": true,//是否收藏 true or false,            "tags": "",//标签            "money": 0,//金额 免费为0            "validity": 365,//购买可用有效期，            "status": 99,////1可试看，2、需购买观看、99为可以观看。            "validityDay": 300,//当前用户剩余播放天数 购买后有限期(天),负数表示已过期            "descript": "",//视频简介            "inputtime": "2014-004-14",//更新时间            "videoList": [{                "id": "38804",  //集id                "title": "食尚厨房",//集名称                "pNumber": "1",//第几集                "hits": "7",//播放次数                "source": "优酷",//来源                "thumb": "http://r2.ykimg.com/0516000051930C27670C4A1AE00A0B29",//封面图                "describe": "",//简介                "status": 99//1可试看，2、需购买观看、99为可以观看。                "minute":0 //可试看分钟数，status=1时该值有值            }            ]    }}

5、视频源地址获取

index.php?m=member&c=app2&a=getViewSource&catid=5&id=3651&auth=d84eAQwAUVFWDFJbVlJTAlFSA1QDUVwBU18CW1sIT1ZfBgZUX14fBQZOCwEASAdJ

参数名称是否必须说明 id 是视频集id

返回示例如下：

{    "status": true,    "code": 0,    "msg": "",    "data": {            "id": "53385",  //id            "title": "曼食慢语 2015",//名称            "pNumber": "1",//集数            "hits": "0",//播放次数            "source": "优酷",//来源            "totalVideo": 84200,//总时长  毫秒数            "status":99,//1可试看，2、需购买观看、99可以观看。            "minute":0 //可试看分钟数，status=1时该值有值            "videoSource": [ //播放地址集                    {                        "url": "http://27.221.83.181/youku/6573DA048523E8363ECFEF36E9/03000101005859068237D718FABCD830B67294-F082-14D7-EB74-FA547177706C.flv?sid=049241495727212cae0ef_00&ctype=12",//播放地址                        "size": "17057029",//文件大小                        "audio": "84614",////音频时长                        "video": "84200"//视频时长毫秒数,时长用于快进的。                    }                ]    }}

6、微信登陆接口

index.php?m=member&c=app2&a=public_login&auth=d84eAQwAUVFWDFJbVlJTAlFSA1QDUVwBU18CW1sIT1ZfBgZUX14fBQZOCwEASAdJ

参数名称是否必须说明 type 否请求类型，默认请求为获取sessionid和扫描二维码，可选参数：type=checkLogin,

返回示例如下：

{    "status": true,    "code": 0,    "msg": "",    "data": {            "sessionid": 20,//sessionid            "erweima": "http://************/uploadfile/2017/0417/1492415321.jpg"//展示给用户扫描的二维码        }}

微信登陆交互流程如下：
1. APP请求服务器接口，获取扫描二维码和sessionid，展示二维码供用户扫描
2. 使用sessionid轮询服务器，查询是否登陆，轮询接口：
index.php?m=member&c=app2&a=public_login&type=checkLogin&sessionid=sessionid&auth=d84eAQwAUVFWDFJbVlJTAlFSA1QDUVwBU18CW1sIT1ZfBgZUX14fBQZOCwEASAdJ
返回示例如下：

{   "status":false,//status = false,未登陆    "code":0,    "msg":"会话不存在或未登陆"}{    "status": true,    "code": 0,    "msg": "",    "data": {            "nickname": "nickname",//昵称            "userid": "userid",//用户ID            "username": "username",//用户登录名            "auth": "d5e1AgQNB1UGAVMNCFdQVQ5UCVAEUQpVUAZXBwFPHgtdCwZWQ0hJ",//app与服务器交互新凭证，客户端需保存新凭证与服务器交互            "thumb": "url",//用户头像            "groupid": "9"//用户会员组 ，暂无实际用途，先保留        }}

7、推荐接口
index.php?m=member&c=app2&a=poster&auth=7a3aVFdbBFAJBwsMAgUBA1BYCwQCVgAGVVUAUwBQSgReAlEBBAVKAF1CWltQH1VI
返回示例：

{    "status": true,    "code": 0,    "msg": "",    "data": {        "poster": [            {                "id": "49",//推荐ID，后续会有接口，当用户点击后调用下接口，统计点击量                "name": "我的",//名称                "image": "http://************/uploadfile/2017/0417/20170417060025973.png",//图片                "linkType": "my",//链接类型                "linkData": ""//链接数据            },            {                "id": "48",                "name": "历史记录",                "image": "http://************/uploadfile/2017/0417/20170417060104847.png",                "linkType": "history",                "linkData": ""            },            {                "id": "55",                "name": "打开webview",                "image": "http://************/uploadfile/2017/0419/20170419022258140.png",                "linkType": "url",                "linkData": "https://**********/"            },            {                "id": "54",                "name": "打开一席",                "image": "http://************/uploadfile/2017/0419/20170419022205197.png",                "linkType": "category",                "linkData": "16"            },            {                "id": "53",                "name": "马云演讲",                "image": "http://************/uploadfile/2017/0414/20170414044309796.jpg",                "linkType": "detail",                "linkData": "20,3930"//linkType=detail,该值为catid,id。用逗号隔开            }        ]    }}

链接类型说明 data 说明 linkType=category {“linkData”: “20”} 打开某一个分类，进入列表 linkType=history {“linkData”: “”} 打开历史记录 linkType=my {“linkData”: “”} 打开我的 linkType=detail {“linkData”: “20,3930”} 打开进入专辑详情页 linkType=url {“linkData”:”http://www.baidu.com“} 打开webview

8、添加关注

index.php?m=member&c=app2&a=collection_add&courseid=53391&auth=483dAA1dUA0PBwMCUgYECVFfW1FdXw4HB11QWlADGlMCAlJVXgMdUFJEWVQHHwI

参数名称是否必须说明 courseid 是专辑ID

返回示例：

{    "status": true,//返回true表示关注成功    "code": 0,    "msg": ""}

9、收藏列表

index.php?m=member&c=app2&a=collection_list&auth=2c1aUABcAAZVVAUGVF0FBABTBQFaUwJWUwRUBgsACEReB1AGUQNVTwEBQ18BXEtQVh8

参数名称是否必须说明 page 否第几页，默认第1页 pageSize 否一页返回数据条数，默认一次返回10条

返回示例

{    "status": true,    "code": 0,    "msg": "",    "data": {        "pageCount": 1,//总页数        "total": "3",//总条数        "rows": [//数据集            {                "id": "3877",//id                "title": "曼食",//名称                "thumb": "",//封面图                "catid": "20",//栏目id                "money": 100//金额            }        ]    }}

10、用户历史记录

index.php?m=member&c=app2&a=history_list&auth=2c1aUABcAAZVVAUGVF0FBABTBQFaUwJWUwRUBgsACEReB1AGUQNVTwEBQ18BXEtQVh8

参数名称是否必须说明 page 否第几页，默认第1页 pageSize 否一页返回数据条数，默认一次返回10条

返回示例：

{    "status": true,    "code": 0,    "msg": "",    "data": {        "pageCount": 1,//总页数        "total": "3",//总条数        "rows": [//数据集合，同收藏列表一致            {                "id": "351",                "title": "可汗学院公开课：三角形",                "thumb": "http://imgsize.ph.126.net/?enlarge=true&imgurl=http://img4.cache.netease.com/video/2012/8/10/201208101130017b43d.jpg_180x100x1x95.jpg",                "catid": "18",                "money": 0            }        ]    }}

11、取消关注

index.php?m=member&c=app2&a=collection_add&type=cancle&courseid=201&auth=44dcAwcNBQFbU1BVVwBXB15SUQtTVQZRVQVSBAFVBU1fVldVVlJQTgYBFQ8CARlTCB4

参数名称是否必须说明 courseid 是视频专辑ID type 是 type=cancle，

返回示例：

{"status":true,"code":0,"msg":""}

12、订阅支付接口

index.php?m=member&c=app2&a=subscribe&courseid=3877&auth=44dcAwcNBQFbU1BVVwBXB15SUQtTVQZRVQVSBAFVBU1fVldVVlJQTgYBFQ8CARlTCB4

参数名称是否必须说明 courseid 是视频专辑ID type 否可选参数为type=checkSubscribe,带此参数表示检查订单是否支付 orderno 否订单号，当type=checkSubscribe时，此参数必须

返回示例：

{    "status": true,    "code": 0,    "msg": "",    "data": {        "orderno": "2017042153485557",//订单号        "erweima": "http://************/uploadfile/2017/0421/1492765285.jpg"//二维码地址    }}

订阅交互流程：
1. APP请求服务器接口，获取扫描二维码和orderno（订单号），展示二维码供用户扫描
2. 使用orderno轮询服务器，查询是否支付成功，轮询接口：
index.php?m=member&c=app2&a=subscribe&type=checkSubscribe&orderno=2017042152534910&auth=44dcAwcNBQFbU1BVVwBXB15SUQtTVQZRVQVSBAFVBU1fVldVVlJQTgYBFQ8CARlTCB4
轮询接口返回示例：

{    "status": false, //为false ，表示订单未支付    "code": 0,    "msg": "订单未支付"}支付成功示例如下：{    "status": true,    "code": 0,    "msg": ""}

13、消费记录

index.php?m=member&c=app2&a=subscribe_list&courseid=201&auth=44dcAwcNBQFbU1BVVwBXB15SUQtTVQZRVQVSBAFVBU1fVldVVlJQTgYBFQ8CARlTCB4

参数名称是否必须说明 page 否第几页，默认第1页 pageSize 否一页返回数据条数，默认一次返回10条

返回示例：

{    "status": true,    "code": 0,    "msg": "",    "data": {        "pageCount": 1,        "total": "2",        "rows": [ //数据集            {                "orderno": "2017042110051495",//订单号                "title": "咔图摄影订阅",//消费名称                "order_type": "subscribe",//订单类型                "starttime": "1970-01-01",//有效期开始时间                "endtime": "2017-05-21",//有效期结束时间                "inputtime": "2017-04-21"//订单时间            },            {                "orderno": "2017042198539850",                "title": "咔图摄影订阅",                "order_type": "subscribe",                "starttime": "1970-01-01",                "endtime": "2017-05-11",                "inputtime": "2017-04-21"            }        ]    }}

14、检查更新

index.php?m=member&c=app2&a=public_update&versionCode=1

参数名称是否必须说明 versionCode 是客户端版本号

返回示例：

{    "status": true,  //返回为true表示有版本更新，否则当前版本为最新版    "code": 0,    "msg": "",    "data": {        "url": "http://*************/app.apk",//新版本下载地址，        "describe": "describedescribedescribedescribe",//更新内容        "versionName": "1.01.0004",//最新版本版本号        "isMustUpdate": true,//是否必须更新，true表示必须，false表示可以暂不更新        "updatetime": "2017-04-25"//更新时间    }}

14、二维码接口

接口地址：
index.php?m=member&c=app2&a=public_erweima&type=contact

参数名称是否必须说明 type=contact 是返回联系我们二维码 type=feedback 是返回意见反馈二维码

{    "status": true,    "code": 0,    "msg": "",    "data": {        "erweima": "http://*************/app/contact.png" //二维码地址    }}

源异常接口

index.php?m=member&c=app2&a=sourceError&partsid=20&auth=44dcAwcNBQFbU1BVVwBXB15SUQtTVQZRVQVSBAFVBU1fVldVVlJQTgYBFQ8CARlTCB4

参数名称是否必须说明 partsid 是视频集ID

返回结果:

{    "status": true,    "code": 0,    "msg": ""}

0 0