[关闭]
@sewise-dev 2016-12-08T01:45:02.000000Z 字数 21862 阅读 815

VPaas平台PHP API接口文档

VPaas

更新历史

编号 版本 说明 作者 日期
1 v1.0 1.创建文档 Seven 2016-06-30

1. 

列表项

目录

【备注】

1. 全局返回码说明

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

返回码 说明
-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/user/register

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
mobile 是 Long 手机号
password 是 String 密码
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":13453077412，"password":"123456"} http://account.sewise.com/v1/user/register
Response
{"status":200,"data":{"userId":"31"}}

1.2 用户登录

接口地址

/v1/user/auth

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestBody
mobile 是 Long 手机号
password 是 String 密码
HTTP 响应状态

200

返回字段 字段类型 说明
status int 返回状态码
message Array 返回错误信息
data Array 返回结果
dataItem
userId int 用户id
access_token String 返回授权签名
expire String 签名过期时间，默认24小时有效
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":13453077412，"password":"123456"} http://account.sewise.com/v1/user/auth
Response
{"status":200,"data":{"userId":"23","access_token":"JfKXafCnfSZrCEkShTIcM3suBFwUBAQi3eocJ5Ol","expire":"2016-07-09 10:51:25"}}

1.3 用户基本信息

接口地址

/v1/user/accountInfo

HTTP Content-Type / 请求方式

application/json
POST/GET

请求参数

方式一 （GET）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）

例如： /v1/user/accountInfo?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户id

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户id
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":22，"token":"#########"} http://account.sewise.com/v1/user/accountInfo
Response
{"status":200,"data":{"userId":"22","mobile":"18675448003","userType":"1","creationDate":"2016-07-06 10:34:54","accountStatus":"1","lastLogin":"2016-07-06 17:42:22","isDelete":"N"}}

1.4 用户详细信息

接口地址

/v1/user/userInfo

HTTP Content-Type / 请求方式

application/json
POST/GET

请求参数

方式一 （GET）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）

例如： /v1/user/userInfo?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户id

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户id
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":22，"token":"#########"} http://account.sewise.com/v1/user/userInfo
Response
{"status":200,"data":{"userId":"22","mobile":"18666666776","email":"123456@163.com",
"emailVerify":"1","userType":"1","rank":"0","creationDate":"2016-07-06 10:34:54","accountStatus":"1","lastLogin":"2016-07-19 11:01:40","isDelete":"N","fId":"2",
"nickName":"\u5f20\u4e09",
"address":"\u6df1\u5733\u5e02\u77fd\u4f1f\u667a\u79d1\u6280
\u6709\u9650\u516c\u53f8","bindValue":"8837263462364"}}

1.5 编辑用户基本信息

接口地址

/v1/user/edit

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
mobile 否 String 要更改成的手机号码
userType 否 int 用户类型：管理用户，普通用户
email 否 String 邮箱
emailVerify 否 int 邮件验证状态:0未验证，1已验证
accountStatus 否 int 用户的状态，如待激活，禁用
lastLogin 否 String 最后登录时间
.....

例如： /v1/user/edit?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
mobile 否 String 要更改成的手机号码
email 否 String 邮箱
emailVerify 否 int 邮件验证状态:0未验证，1已验证
userType 否 int 用户类型：管理用户，普通用户
accountStatus 否 int 用户的状态，如待激活，禁用
lastLogin 否 String 最后登录时间
.....

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户id
mobile 否 String 要更改成的手机号码
email 否 String 邮箱
emailVerify 否 int 邮件验证状态:0未验证，1已验证
userType 否 int 用户类型：管理用户，普通用户
accountStatus 否 int 用户的状态，如待激活，禁用
lastLogin 否 String 最后登录时间
.....

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户id
mobile 否 String 要更改成的手机号码
email 否 String 邮箱
emailVerify 否 int 邮件验证状态:0未验证，1已验证
userType 否 int 用户类型：管理用户，普通用户
accountStatus 否 int 用户的状态，如待激活，禁用
lastLogin 否 String 最后登录时间
.....
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"22","mobile":"13424284710","email":"123456@163.com",“userType”:"1"，"token":"#########"} http://account.sewise.com/v1/user/edit
Response
{"status":200,"message":["\u4fee\u6539\u6210\u529f"]}

1.6 验证已登录用户密码

接口地址

/v1/user/authPass

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
password 是 String 帐户密码

例如： /v1/user/authPass?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
password 是 String 帐户密码

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户id
password 是 String 帐户密码

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户id
password 是 String 帐户密码
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"22","password":"123456"，"token":"#########"} http://account.sewise.com/v1/user/authPass
Response
{"status":200,"message":["\u5bc6\u7801\u6b63\u786e"]}

1.7 重置密码

接口地址

/v1/user/reset

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
password 是 String 帐户密码

例如： /v1/user/reset?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
password 是 String 帐户密码

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户id
password 是 String 帐户密码

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户id
password 是 String 帐户密码
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"22","password":"123456"，"token":"#########"} http://account.sewise.com/v1/user/reset
Response
{"status":200,"message":["\u5bc6\u7801\u91cd\u7f6e\u6210\u529f"]}

1.8 登录记录

接口地址

/v1/user/record

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
page 否 int 页数
pageSize 否 int 页码
order 否 String 排序

例如： /v1/user/record?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
page 否 int 页数
pageSize 否 int 页码
order 否 String 排序

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户uid
page 否 int 页数
pageSize 否 int 页码
order 否 String 排序

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户uid
page 否 int 页数
pageSize 否 int 页码
order 否 String 排序
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"32"，"token":"#########"，"page":"1","pageSize":"20","order":"aId DESC"} http://account.sewise.com/v1/user/record
Response
{"status":200,"data":{"total_page":1,"page":"1","pagesize":"20","total_record":1,"record":[{"area":"\u5e7f\u4e1c \u6df1\u5733","ip":"127.0.0.1","loginDate":"2016-07-18 13:46:50"}]}}

1.9 手机号是否存在

接口地址

/v1/user/checkMobile

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
mobile 是 int 手机号

例如： /v1/user/checkMobile?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
mobile 是 int 手机号

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
mobile 是 int 手机号

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
mobile 是 int 手机号
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":"32"，"token":"#########"} http://account.sewise.com/v1/user/checkMobile
Response
{"status":200,"data":{"userId":"16"}}

2.消息中心

2.1 短信发送

接口地址

/v1/sms/send

HTTP Content-Type / 请求方式

application/json
POST

请求参数
参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
moible 是 String 手机号码
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"mobile":"13888888888"，"token":"#########"} http://account.sewise.com/v1/sms/send
Response
{"status":200,"message":"\u53d1\u9001\u6210\u529f","data":{"mobile":"13888888888","code":"389123"}}

3.资源库

3.1 文件上传保存

接口地址

/v1/media/save

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
fileName 是 String 文件名称
sourceId 是 String 视频文件源sourceId
format 是 String 文件格式
url 否 String 媒资地址
img 否 String 媒资截图
duration 否 float 媒资时长
size 是 bigint 文件的字节数
dimension 否 String 分辨率:(640*480)
bitrate 否 int 码率:(480)
framerate 否 String 帧率:(25fbps)
status 是 int 状态： 0，不可用 ； 1，可用
isReferenced 否 int 使用状态： 0，未引用 ；1，引用
catalog 是 int 素材所属的目录ID
transcodeId 否 String 转码任务ID
workerUrl 否 String 服务的worker地址

例如： /v1/media/save?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
fileName 是 String 文件名称
sourceId 是 String 视频文件源sourceId
format 是 String 文件格式
url 是 String 媒资地址
img 是 String 媒资截图
duration 是 float 媒资时长
size 是 bigint 文件的字节数
dimension 是 String 分辨率:(640*480)
bitrate 是 int 码率:(480)
framerate 否 String 帧率:(25fbps)
status 是 int 状态： 0，不可用 ； 1，可用
isReferenced 否 int 使用状态： 0，未引用 ；1，引用
catalog 是 int 素材所属的目录ID
transcodeId 否 String 转码任务ID
workerUrl 否 String 服务的worker地址

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户uid
fileName 是 String 文件名称
sourceId 是 String 视频文件源sourceId
format 是 String 文件格式
url 是 String 媒资地址
img 是 String 媒资截图
duration 是 float 媒资时长
size 是 bigint 文件的字节数
dimension 是 String 分辨率:(640*480)
bitrate 是 int 码率:(480)
framerate 否 String 帧率:(25fbps)
status 是 int 状态： 0，不可用 ； 1，可用
isReferenced 否 int 使用状态： 0，未引用 ；1，引用
catalog 是 int 素材所属的目录ID
transcodeId 否 String 转码任务ID
workerUrl 否 String 服务的worker地址

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户uid
fileName 是 String 文件名称
sourceId 是 String 视频文件源sourceId
format 是 String 文件格式
url 是 String 媒资地址
img 是 String 媒资截图
duration 是 float 媒资时长
size 是 bigint 文件的字节数
dimension 是 String 分辨率:(640*480)
bitrate 是 int 码率:(480)
framerate 否 String 帧率:(25fbps)
status 是 int 状态： 0，不可用 ； 1，可用
isReferenced 否 int 使用状态： 0，未引用 ；1，引用
catalog 是 int 素材所属的目录ID
transcodeId 否 String 转码任务ID
workerUrl 否 String 服务的worker地址
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"fileName":"我的收藏"，"token":"#########",....} http://account.sewise.com/v1/media/save
Response
{"status":200,"data":{"mId":"10"}}

3.2 文件信息

接口地址

/v1/media/info

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
mId 是 int 文件平台编号

例如： /v1/media/save?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
mId 是 int 文件平台编号

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户uid
mId 是 int 文件平台编号

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户uid
mId 是 int 文件平台编号
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"mId":"1"，"userId":"16","token":"#########",....} http://account.sewise.com/v1/media/info
Response
{"status":200,"data":{"mId":"1","userId":"16","fileName":"07-\u6587\u4ef6\u9884\u89c8.mp4","sourceId":"b6bf85c272d15b25fcf20e7bcdcc7ad1",
"format":"mp4","url":null,"img":"\/templates\/media\/assets\/images\/test3.png",
"duration":"59","size":"9180197","dimension":null,
"bitrate":"0","framerate":null,"status":"0","isReferenced":"0",
"modifiedDate":"2016-08-24 14:47:10","catalog":"22","transcodeId":null}}

3.3 文件列表

接口地址

/v1/media/list

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
catalog 否 int 素材所属的目录ID，默认所有目录
page 否 int 页数，默认1
pageSize 否 int 页码，默认20
order 否 String 排序，默认mId倒序（fileName/modifiedDate DESC）

例如： /v1/media/list?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
catalog 否 int 素材所属的目录ID，默认所有目录
page 否 int 页数，默认1
pageSize 否 int 页码，默认20
order 否 String 排序，默认倒序

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户uid
catalog 否 int 素材所属的目录ID，默认所有目录
page 否 int 页数，默认1
pageSize 否 int 页码，默认20
order 否 String 排序，默认倒序

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户uid
catalog 否 int 素材所属的目录ID，默认所有目录
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 {"userId":"22"，"token":"#########","catalog":"1"} http://account.sewise.com/v1/media/create
Response
{"status":200,"data":{"total_page":1,"page":"1","pagesize":"20","total_record":1,"record":[{"mId":"1","userId":"22","fileName":"zorro.flv","sourceId":"q2zxtx6v","format":"flv","url":"http:\/\/192.168.1.36\/source\/data\/j293ksdjsdfes.ts","img":"http:\/\/192.168.1.36\/data\/userdata\/vlive\/images\/201606\/2317414624.jpg","duration":"118","size":"24488692","dimension":"1280*720","bitrate":"480","framerate":"25","status":"1","isReferenced":"0","modifiedDate":"2016-07-28 10:14:11","catalog":"1"}]}}

3.4 文件删除

接口地址

/v1/media/delete

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
mId 是 Long 文件ID

例如： /v1/media/delete?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
mId 是 Long 文件ID

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户uid
mId 是 Long 文件ID

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户uid
mId 是 Long 文件ID
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"13","mId":"2","token":"#########"} http://account.sewise.com/v1/media/delete
Response
{"status":200,"message":"\u5220\u9664\u6210\u529f"}

4.任务设置

4.1 创建目录

接口地址

/v1/task/createNode

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
name 是 String 名称
parentId 否 int 父节点id，默认根节点

例如： /v1/task/createNode?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
name 是 String 名称
parentId 否 int 父节点id，默认根节点

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户uid
name 是 String 目录名称
parentId 是 int 父节点id

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户uid
name 是 String 名称
parentId 否 int 父节点id，默认根节点
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"name":"我的收藏"，"token":"#########"} http://account.sewise.com/v1/task/createNode
Response
{"status":200,"data":{"nId":"10","name":"\u6211\u7684\u6536\u85cf","parentId":"0","userId":"22","modifiedDate":"2016-07-22 17:47:25","isDelete":"N"}}

4.2 编辑目录

接口地址

/v1/task/editNode

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
nId 是 Long 目录ID
name 是 String 名称
parentId 否 int 父节点id，默认根节点

例如： /v1/task/editNode?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
nId 是 Long 目录ID
name 是 String 名称
parentId 否 int 父节点id，默认根节点

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户uid
nId 是 Long 目录ID
name 是 String 名称
parentId 否 int 父节点id，默认根节点

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户uid
nId 是 Long 目录ID
name 是 String 名称
parentId 否 int 父节点id，默认根节点
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"name":"我的收藏","parentId":"2","token":"#########"} http://account.sewise.com/v1/task/editNode
Response
{"status":200,"message":"\u4fee\u6539\u6210\u529f","data":{"nId":"1","name":"\u83e9\u63d0\u672c\u65e0\u6811","parentId":"0","userId":"22","modifiedDate":"2016-07-22 17:51:21","isDelete":"N"}}

4.3 删除目录

接口地址

/v1/task/deleteNode

HTTP Content-Type / 请求方式

application/json
POST

请求参数

方式一 （POST）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
nId 是 Long 目录ID

例如： /v1/task/deleteNode?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
nId 是 Long 目录ID

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户uid
nId 是 Long 目录ID

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户uid
nId 是 Long 目录ID
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"13","nId":"2","token":"#########"} http://account.sewise.com/v1/task/deleteNode
Response
{"status":200,"message":"\u5220\u9664\u6210\u529f"}

4.4 获取工作空间目录树形结构

接口地址

/v1/task/treeNode

HTTP Content-Type / 请求方式

application/json
POST/GET

请求参数

方式一 （POST/GET）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）

例如： /v1/task/treeNode?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户uid

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户uid
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"22","token":"#########"} http://account.sewise.com/v1/task/treeNode
Response
{"status":200,"data":[{"nId":"1","name":"\u83e9\u63d0\u672c\u65e0\u6811","parentId":"0","children":[{"nId":"2","name":"\u5468\u6770\u4f26","parentId":"1"},{"nId":"5","name":"\u90a3\u82f1","parentId":"1"},{"nId":"6","name":"JJ\u6797\u4fca\u6770","parentId":"1"}]},{"nId":"3","name":"\u6700\u559c\u6b22\u7684\u6b4c","parentId":"0","children":[{"nId":"4","name":"Jar Of Love","parentId":"3"},{"nId":"7","name":"\u6f14\u5458","parentId":"3"},{"nId":"8","name":"\u7231\u7684\u9b54\u6cd5","parentId":"3"},{"nId":"9","name":"\u624b\u5199\u7684\u4ece\u524d","parentId":"3"}]},{"nId":"10","name":"\u6211\u7684\u6536\u85cf","parentId":"0"}]}

4.5 创建课件

接口地址

/v1/task/makeTutorial

HTTP Content-Type / 请求方式

application/json
POST/GET

请求参数

方式一 （POST/GET）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
taskName 是 String 课件名称
pdfJson 否 string pdf同步数据
vttArrData 否 String 字幕同步数据
status 否 int 状态： 0.未发布 1.已发布
.....

例如： /v1/task/makeTutorial?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
taskName 是 String 课件名称
pdfJson 否 string pdf同步数据
vttArrData 否 String 字幕同步数据
status 否 int 状态： 0.未发布 1.已发布
.....

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户uid
taskName 是 String 课件名称
pdfJson 否 string pdf同步数据
vttArrData 否 String 字幕同步数据
status 否 int 状态： 0.未发布 1.已发布
.....

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户uid
taskName 是 String 课件名称
pdfJson 否 string pdf同步数据
vttArrData 否 String 字幕同步数据
status 否 int 状态： 0.未发布 1.已发布
.....
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"22","taskName":"#########","pdfJson:"####"} http://account.sewise.com/v1/task/makeTutorial
Response
{"status":200,"message":"保存成功","data":[{"taskId":"1"}]}

4.6 获取一个课件详情

接口地址

/v1/task/tutorialInfo

HTTP Content-Type / 请求方式

application/json
POST/GET

请求参数

方式一 （POST/GET）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
taskId 是 int 课件ID

例如： /v1/task/tutorialInfo?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
taskId 是 int 课件ID

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户uid
taskId 是 int 课件ID

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户uid
taskId 是 int 课件ID
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"22","taskId":"1"} http://account.sewise.com/v1/task/tutorialInfo
Response
{"status":200,"data":[{"taskId":"1","taskName":"###",...}]}

4.7 编辑一个课件信息

接口地址

/v1/task/editTutorial

HTTP Content-Type / 请求方式

application/json
POST/GET

请求参数

方式一 （POST/GET）

参数 必选 类型 说明
PathParam
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
taskId 是 int 课件ID
taskName 否 string 课件名称
taskExtra 否 text 课件内容
status 否 int 课件状态，0：未发布 1：已发布

例如： /v1/task/editTutorial?access_token={access_token}
或：

参数 必选 类型 说明
RequestHeader
access_token 是 String 授权签名（用户登陆成功返回的access_token）
RequestBody
taskId 是 int 课件ID
taskName 否 string 课件名称
taskExtra 否 text 课件内容
status 否 int 课件状态，0：未发布 1：已发布

方式二 （POST）

参数 必选 类型 说明
RequestHeader
token 是 String 管理员/内部调用授权签名
RequestBody
userId 是 Long 用户uid
taskId 是 int 课件ID
taskName 否 string 课件名称
taskExtra 否 text 课件内容
status 否 int 课件状态，0：未发布 1：已发布

方式三 （POST）

参数 必选 类型 说明
RequestHeader
unLoginToken 是 String 免登陆授权签名
RequestBody
userId 是 Long 用户uid
taskId 是 int 课件ID
taskName 否 string 课件名称
taskExtra 否 text 课件内容
status 否 int 课件状态，0：未发布 1：已发布
HTTP 响应状态

200

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

Request
curl -X POST -H "Content-Type:application/json" -d {"userId":"22","taskId":"1","taskName":"####","taskExtra":"####","status":"####"} http://account.sewise.com/v1/task/editTutorial
Response
{"status":200,"message":""}]}

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