@sewise-dev
2017-01-03T09:51:40.000000Z
字数 3700
阅读 478
VPaas组件化
媒资平台
编号 | 版本 | 说明 | 作者 | 日期 |
---|---|---|---|---|
2 | v1.0 | 1.0.完善文档 | jacky | 2016-12-29 |
凡是要使用应用能力的接口,双方需通过对比加密sign值,进行安全校验,否则接口不能使用。
加密算法:
sign = md5(shal(appid + time + random) + key);
每次调用接口时,可能获得正确或错误的返回码,开发者可以根据返回码信息调试接口,排查错误。
返回码 | 说明 |
---|---|
-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}
}
/v1/program/category
application/json
POST
参数 必选 类型 说明
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
data | Array | 返回结果 |
Request
curl -X POST -H "Content-Type:application/json" http://program.sewise.com/v1/program/category
Response
{
"status": 200,
"data": [{"cId":"4","name":"视频4","level":"3","parentId":"2"},{"cId":"6","name":"目录2","parentId":"0","level":"1","children":[{"cId":"7","name":"视频","level":"2","parentId":"1"}]}]
}
/v1/program/delCategory
application/json
POST
参数 必选 类型 说明 RequestBody cId 是 Int 分类Id;删除父节点时,前端应该提示:确定删除该分类和其分类下的子分类?用户确定后才提交请求
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
data | Array | 返回结果 |
Request
curl -X POST -H "Content-Type:application/json" -d {"cId":"2"}
http://porgram.sewise.com/v1/program/delCategory
Response
{
"status": 200,
"message": "删除成功",
}
/v1/program/editCategory
application/json
POST
参数 必选 类型 说明 RequestBody cId 是 Int 分类Id name 是 String 目录名称
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
data | Array | 返回结果 |
Request
curl -X POST -H "Content-Type:application/json" -d {"cId":"2","name":"视频","parentId":"1"} http://porgram.sewise.com/v1/porgram/editCategory
Response
{
"status": 200,
"message": "修改成功",
"data": {
"cId": "2",
"name": "视频",
"parentId": "1",
"userId": "1",
"aId": "1",
"modifiedDate": "2016-12-14 11:06:24",
"status": "1"
}
}
/v1/media/createCategory
application/json
POST
参数 必选 类型 说明 RequestBody name 是 String 目录名称 parentId 否 Int 父节点id
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
message | String | 返回错误信息 |
data | Array | 返回结果 |
Request
curl -X POST -H "Content-Type:application/json" -d {"name":"默认目录","parentId":"12"} http://porgram.sewise.com/v1/porgram/createCategory
Response
{
"status": 200,
"data": {
"cId": "3",
"name": "视频录像",
"parentId": "1",
"userId": "1",
"aId": "1",
"status":1
}
}
/v1/program/list
application/json
POST
参数 必选 类型 说明 RequestBody cId 否 Int 分类点id
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
data | Array | 返回结果 |
Request
curl -X POST -H "Content-Type:application/json" http://program.sewise.com/v1/program/list
Response
{
"status": 200,
"data": []
}
/v1/program/delete
application/json
POST
参数 必选 类型 说明 RequestBody programIds 是 Int 媒资Id组成的数组转的字符串(如 "1,2,3")
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
data | Array | 返回结果 |
Request
curl -X POST -H "Content-Type:application/json" http://program.sewise.com/v1/program/delete
Response
{
"status": 200,
"message": "删除成功",
}
/v1/program/search
application/json
POST
参数 必选 类型 说明 RequestBody programId 是 Int 节目Id)
200
返回字段 | 字段类型 | 说明 |
---|---|---|
status | int | 返回状态码 |
data | Array | 返回结果 |
Request
curl -X POST -H "Content-Type:application/json" http://program.sewise.com/v1/program/delete
Response
{
"status": 200,
"message": "删除成功",
}