[关闭]
@sewise-dev 2016-12-19T06:36:55.000000Z 字数 3853 阅读 813

(快电影)VPaas平台PHP API接口文档#

VPaas组件化 快电影


更新历史

编号 版本 说明 作者 日期
1 v1.0 1.创建文档 cjr 2016-12-16

目录

1. 对接方式、鉴权认证(暂不验证)

凡是要使用应用能力的接口,双方需通过对比加密sign值,进行安全校验,否则接口不能使用。

加密算法:
sign = md5(shal(appid + time + random) + key);

成功样例
http://movie.seiwse.com/v1/movie/info?appid=ic89rf8705ztf6uip7&time=1481600689&sign=818b8ca06a1dc4811d25983d6b19bfc3&random=123456

2. 全局返回码说明

每次调用接口时,可能获得正确或错误的返回码,开发者可以根据返回码信息调试接口,排查错误。

返回码 说明
-1 系统繁忙,此时请开发者稍候再试
200 请求成功
403 禁止访问
404 异常错误
500 数据验证错误
40001 不合法的凭证,或者access_token无效。
40004 不合法请求

HTTP请求状态返回格式

返回字段 字段类型 说明
status Integer 请求返回码(详细请见状态表)
message String 返回描述
data Array 返回结果

错误样例
{
"status": 40013,
"message": {"0":"invalid appid"}
}
成功样例
{
"status": 200,
"data": {"access_token":"ACCESS_TOKEN","expires_in":7200}
}


1.节目接口

1.1 创建一个节目

接口地址

/v1/movie/createProgram

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
org_id string 机构id
title string 节目标题
poster string 节目海报
cover string 节目海报(横版)
description string 简介
prevue string (媒资id组成的数组转换为json)
expect_time string 预计时间
voddata string (媒资id组成的数组转换为json)
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"org_id":"1",
"title":"aaaa","poster":"","cover":"","description":"","prevue":"","expect_time":"",
"voddata":""}
http://movie.seiwse.com/v1/movie/createNode
Response
{
"status": 200,
"data": {
"programid": "3",
}
}

1.2 编辑一个节目

接口地址

/v1/movie/editProgram

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
programid string 节目id
org_id string 机构id
title string 节目标题
poster string 节目海报
cover string 节目海报(横版)
description string 简介
prevue string (媒资id组成的数组转换为json)
expect_time string 预计时间
voddata string (媒资id组成的数组转换为json)
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"programid":"2","org_id":"1",
"title":"aaaa","poster":"","cover":"","description":"","prevue":"","expect_time":"","voddata":""} http://movie.seiwse.com/v1/movie/editProgram
Response
{
"status": 200,
"message": "修改成功"
}

1.3 删除一个节目

接口地址

/v1/movie/deleteProgram

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
programid string (节目id组成的数组转换为json)
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"programid":"2"}
http://movie.seiwse.com/v1/movie/deleteProgram
Response
{
"status": 200,
"message": "删除成功",
}

1.4 获取节目统计数据

接口地址

/v1/movie/getCount

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
org_id int 机构id,默认为0,返回所有
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"org_id":"0"}
http://movie.seiwse.com/v1/movie/getCount
Response
{
"status": 200,
"data": "{统计数据}",
}

1.6 文件信息

接口地址

/v1/movie/info

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
programid string 节目id
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"programid":"1"}
http://movie.seiwse.com/v1/movie/info
Response
{"status":200,"data":{节目信息}}

1.7 文件列表

接口地址

/v1/movie/list

HTTP Content-Type / 请求方式

application/json
GET/POST

请求参数
参数 必选 类型 说明
RequestBody
catalog int 分类ID,默认所有分类
keyword String 关键词,默认所有
selectstatus int 过滤的状态,默认所有
page int 页数,默认1
pageSize int 页码,默认20
order String 排序,默认倒序
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message String 返回错误信息
data Array 返回结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"catalog":"","page":"1","pageSize":"20","order":"programid Desc","keyword":"aaa","selectstatus":0}
http://movie.seiwse.com/v1/movie/list
Response
{"status":200,"data":{"total_page":1,"page":"1","pagesize":"20","total_record":1,"record":[{节目数据}]}}

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注