网络文件柜系统接口v22.docx
《网络文件柜系统接口v22.docx》由会员分享，可在线阅读，更多相关《网络文件柜系统接口v22.docx（19页珍藏版）》请在冰豆网上搜索。
网络文件柜系统接口v22
网络文件柜系统接口说明
V2.2
北京育网阳光科技有限公司
目录
1文档说明3
2公共数据3
2.1接口地址与访问方法3
3接口定义3
3.1基础接口3
3.1.1用户登录3
3.1.2获取FTP账号与密码4
3.2磁盘接口4
3.2.1获取磁盘id4
3.2.2获取有查看权限的磁盘列表5
3.2.3获取磁盘权限6
3.3目录接口7
3.3.1新增目录7
3.3.2修改目录名7
3.3.3删除目录8
3.3.4获取目录信息9
3.3.5获取目录清单9
3.4文件接口10
3.4.1新增文件10
3.4.2检查文件md5值11
3.4.3修改文件名12
3.4.4删除文件13
3.4.5获取文件信息13
3.4.6获取文件清单14
3.5临时接口15
3.5.1获取同步盘文件15
1文档说明
本文档提供的接口仅供开发上传下载客户端和服务器通讯使用。
以下所有定义的接口均采用短链接的http协议进行通讯，使用POST方式提交，提交数据格式为String，返回数据格式为String或JSON，除特殊说明外按接口描述。
所有post请求和返回结果中参数统一为小写字母。
接口中定义的参数都不可遗漏，即使该字段为空。
2公共数据
2.1接口地址与访问方法
地址：
http:
//222.126.246.175:
5080/
方法：
客户端传进参数类型String，服务器返回String或JSON数据。
3接口定义
3.1基础接口
3.1.1用户登录
说明：
用户登录
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
login（Stringloginname,Stringpassword）
【返回结果】
字段名
类型
描述
String
成功success,失败failure
示例
login（“admin”，”test”）
3.1.2获取FTP账号与密码
说明：
客户端上传时ftp账号
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
getFtpInfo（）
【返回结果】
字段名
类型
描述
ip
String
Ip地址
port
String
端口
username
String
用户名
password
String
密码
getFtpInfo（）
示例:
{"ip":
"222.126.246.175","port":
"21","username":
"admin","password":
"2345678"}
3.2磁盘接口
3.2.1获取磁盘id
说明：
通过客户端获取磁盘id
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
getDiskid（Stringloginname,Stringpassword,Stringdisktype）
【参数格式】
字段名
类型
描述
loginname
String
用户登录名
password
String
用户密码
disktype
String
磁盘类型
getDiskid（“admin”,”gaocl”,”1”）
【返回结果】
3.2.2获取有查看权限的磁盘列表
说明：
通过客户端获取有查看权限的磁盘列表
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
getDiskInfos（Stringloginname,Stringpassword）
【返回结果】磁盘json列表
字段名
类型
描述
diskid
String
磁盘id
letter
String
盘符
diskname
String
磁盘名称
userid
String
用户id
disktype
String
磁盘类型,0私有盘，1公共盘，2临时盘，3同步盘
needcheck
String
0不需要审核，1需要审核
【参数格式】
字段名
类型
描述
loginname
String
用户登录名
password
String
用户密码
调用示例：
getDiskInfos（“admin”,”gaocl”）
返回示例:
{"diskid”:
"1","letter":
"B","diskname":
"同步盘","userid":
"1","disktype":
"3",”needcheck”:
”1”}获取同步盘目录
说明：
通过客户端获取同步盘目录
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
getSyncDiskFolderInfos（Stringloginname，Stringpassowrd）
【参数格式】
字段名
类型
描述
loginname
String
用户登录名
password
String
用户密码
getSyncDiskFolderInfos（“admin”,”javadev”）
【返回结果】
3.2.3获取磁盘权限
说明：
获取某个用户对某个磁盘的操作权限
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
getDiskPower（Stringloginname,Stringpassword,Stringdiskid）
【参数格式】
字段名
类型
描述
loginname
String
用户登录名
password
String
用户密码
【返回结果】
Int型
数值
类型
描述
0x0001
int
增加目录
Ox0002
int
删除目录
0x0004
int
修改目录
Ox0008
int
上传文件
0x0010
int
删除文件
0x0020
int
修改文件
0x0040
int
下载文件
0x0080
int
批量标签
0x0100
int
查看权限
3.2.4重新统计
说明：
重新统计磁盘信息,批量上传完文件后调用一次
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
getCountByDiskid（Stringloginname,Stringpassword,Stringdiskid）
【参数格式:
】
字段名
类型
描述
loginname
String
用户登录名
password
String
用户密码
diskid
String
磁盘id
【返回结果】
Success,failure
3.3目录接口
3.3.1新增目录
说明：
通过客户端上传目录
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
addFolder（Stringloginname,Stringpassword,Stringdiskid,Stringfolderid,Stringfoldername）
【返回结果】
字段名
类型
描述
String
成功folder对像的json字符串
失败failure
【参数格式】
字段名
类型
描述
loginname
String
用户登录名
password
String
用户密码
diskid
String
所在磁盘id
parentid
String
上级目录id
foldername
String
上传的目录名
addFolder（“admin”,“1”,”1”，“我的文章”）
返回格式
jsonObject.put（"folderid",ffi.getId（））;
jsonObject.put（"parentid",ffi.getParentid（））;
jsonObject.put（"foldername",ffi.getFoldername（））;
jsonObject.put（"diskid",ffi.getDiskid（））;
3.3.2修改目录名
说明：
通过客户端修改目录名
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
updateFolder（Stringloginname,Stringpassword,Stringfolderid,Stringfoldername）
【返回结果】
字段名
类型
描述
String
成功folder对像的json字符串
失败failure
【参数格式】
字段名
类型
描述
loginname
String
用户登录名
password
String
用户密码
folderid
String
文件夹id
foldername
String
新的文件夹名
示例
updateFilename（“admin”,“gaocl”，“12”,“新的文件夹”）
3.3.3删除目录
说明：
通过客户端删除目录
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
delFolder（Stringloginname,Stringpassword,Stringfolderid）
【返回结果】
字段名
类型
描述
String
成功success,失败failure
【参数格式】
字段名
类型
描述
loginname
String
用户登录名
password
String
用户密码
folderid
String
文件夹id
示例
delFolder（“admin”,“gaocl”，“12”）
3.3.4获取目录信息
说明：
获取目录全部信息
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
getFolderInfo（Stringloginname,Stringpassword,Stringfolderid）
【返回结果】
字段名
类型
描述
folderid
String
目录id
foldername
String
目录名
parentid
String
父目录id,根目录为0
diskid
String
磁盘id
【参数格式】
字段名
类型
描述
loginname
String
登录用户名
password
String
用户密码
folderid
String
文件夹id
3.3.5获取目录清单
说明：
通过客户端获取目录清单
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
getFolderInfos（Stringloginname,Stringpassword,Stringdiskid,Stringparentid）
【返回结果】
字段名
类型
描述
folderid
String
目录id
foldername
String
目录名
parentid
String
父目录id,根目录为0
diskid
String
磁盘id
【参数格式】
字段名
类型
描述
loginname
String
用户登录名
password
String
用户密码
diskid
String
磁盘id
parentid
String
父文件夹id,根文件夹的parentid为”0”,如果父id为空“”，则会取出所有文件夹
getFolderInfos（Stringloginname,Stringpassword,Stringdiskid,Stringparentid）
返回示例:
{"folderid":
"1","foldername":
"我的文件夹","parentid":
"0",”diskid”:
”1”}
3.4文件接口
3.4.1新增文件
说明：
通过客户端上传文件
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
addFile（Stringloginname,Stringpassword,Stringdiskid,Stringfolderid,Stringfilename,Stringfiletype,Stringsavepath,Longfilesize,Stringmd5,Stringneedcheck,Stringcover）
【返回结果】
字段名
类型
描述
String
成功success,失败failure,存在exist
【参数格式】
字段名
类型
描述
loginname
String
用户登录名
password
String
用户密码
diskid
String
文件所有磁盘id
folderid
String
文件所在目录id
filename
String
上传的文件名
filetype
String
文件类型，即文件扩展名
savepath
String
服务器相对于ftp根路径的uuid地址
filesize
Long
上传的文件大小字节数
md5
String
文件md5值
needcheck
String
0不需要审核，1需要审核
cover
String
存在同名文件时的操作0不操作，1覆盖，2新文件
示例
addFile（“admin”,“gaocl”,“12”,”1”，“我的中国心.doc”，“doc”，“aadfasdfadfadfasdfadsfasdfa.doc”，”10234444”,“adfasdfasdfasdfasdfasdfasdf”，”1”，”2”）
3.4.2检查文件md5值
说明：
检查是否存在该md5值的文件
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
checkMd5（Stringloginname,Stringpassword,Stringmd5）
【返回结果】
字段名
类型
描述
String
成功success,失败failure
【参数格式】
字段名
类型
描述
loginname
String
用户登录名
password
String
用户密码
md5
String
文件md5值
示例
checkMd5（“admin”,“gaocl”,“aadfasdfadfadfasdfadsfasdfa”）
3.4.3修改文件名
说明：
通过客户端修改文件名（同步盘）
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
updateFilename（Stringloginname,Stringpassword,Stringfileid,Stringfilename）
【返回结果】
字段名
类型
描述
String
成功success,失败failure
【参数格式】
字段名
类型
描述
loginname
String
用户登录名
password
String
用户密码
fileid
String
文件id
filename
String
新的文件名
示例
updateFilename（“admin”,“gaocl”,“12”,“我的中国心.doc”）
3.4.4删除文件
说明：
通过客户端删除文件（同步盘）
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
delFile（Stringloginname,Stringfileid）
【返回结果】
字段名
类型
描述
String
成功success,失败failure
【参数格式】
字段名
类型
描述
loginname
String
用户登录名
password
String
用户密码
fileid
String
文件id
示例
delFile（“admin”,“gaocl”，“12”）
3.4.5获取文件信息
说明：
通过客户端下载时获取文件信息
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
getFileInfo（Stringloginname,Stringpassword,Stringfileid）
【返回结果】
字段名
类型
描述
fileid
String
文件id
filename
String
文件名
icon
String
文件缩略图
filesize
Long
文件大小字节数
createdate
String
创建日期
filetype
String
文件类型
fileext
String
文件扩展名
fileurl
String
文件的真实http路径
userid
String
用户id
usernmae
String
用户姓名
folderid
String
文件夹id
diskid
String
磁盘id
【参数格式】
字段名
类型
描述
loginname
String
用户登录名
password
String
用户密码
fileid
String
文件id
getFileInfo（“admin”,“gaocl”，”1”）
示例:
{"filename":
"default.gif","filesize":
"2345678","fileurl":
"http:
//222.126.246.175:
8080/upload_dir/default.gif"}
3.4.6获取文件清单
说明：
通过客户端下载时获取文件信息
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
getFileInfos（Stringloginname,Stringpassword,Stringdiskid,Stringfolderid）
【参数格式】
字段名
类型
描述
loginname
String
用户登录名
password
String
用户密码
diskid
String
磁盘id
folderid
String
父文件夹id,如果父id为“”，则会取出所有文件
getFileInfos（“admin”，“gaocl”，“1”，“2”）
【返回结果】
字段名
类型
描述
fileid
String
文件id
filename
String
文件名
filesize
Long
文件大小字节数
icon
String
文件缩略图
createdate
String
上载日期
filetype
String
文件类型,1图片，2视频，3音频，4文档，5其它
fileext
String
文件扩展名
fileurl
String
文件相对于域名的真实http路径
Upload_dir/file/201312/1.jpg
userid
String
用户id
username
String
用户姓名
folderid
String
文件夹id
diskid
String
磁盘id
3.5临时接口
3.5.1获取同步盘目录
说明：
通过客户端获取同步盘目录
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
getSyncDiskFolderInfos（Stringloginname，Stringpassowrd）
【参数格式】
字段名
类型
描述
loginname
String
用户登录名
password
String
用户密码
getSyncDiskFolderInfos（“admin”,”javadev”）
【返回结果】
3.5.2获取同步盘文件
说明：
通过客户端获取同步盘文件
【提交请求】
地址：
service/ClientWebService?
wsdl
方法名：
getSyncDiskFileInfos（Stringloginname,Stringpassword）
【参数格式】
字段名
类型
描述
loginname
String
用户登录名
password
String
用户密码
getSyncDiskFileInfos（“admin”,”123456”）
【返回结果】
升级会员 