云文档上传和获取服务端调用

目录

1, 获取APP剩余空间

获取APP剩余空间

接口说明

获取APP剩余空间

请求说明

[GET] https://openapi.wps.cn/oauthapi/v2/appfile/remaining

参数说明

参数参数类型是否必须说明
access_tokenstringrequiredaccess_token
appidstringrequired应用唯一标识

Header说明

Header名称是否必须说明
Content-typerequired值为:application/json

返回

{ "remaining":REMAINING, "result":0}

2, 获取文件列表

获取文件列表

接口说明

获取文件列表

请求说明

[GET] https://openapi.wps.cn/oauthapi/v2/files

参数说明

参数参数类型是否必须说明
access_tokenstringrequiredaccess_token
appidstringrequired应用唯一标识
parentidint64required文件夹所在父目录 默认为0
orderstringfalse排序规则(ASC/DESC) 默认为DESC
orderbystringfalse排序依据内容(fname/mtime) 默认为mtime
offsetstringfalse获取文件的初始值,默认为0
countstringfalse获取文件数量,默认为30

Header说明

Header名称是否必须说明
Content-typerequired值为:application/json

返回

{ "files":[ { "id":ID, "fname":"FNAME", "ftype":"FTYPE" } ], "result":0}

3, 创建文件夹

创建文件夹

接口说明

创建文件夹

请求说明

[POST] https://openapi.wps.cn/oauthapi/v2/folders/create

参数说明

参数参数类型是否必须说明
access_tokenstringrequiredaccess_token
parentidint64required文件夹所在父目录
namestringrequired文件夹名

Header说明

Header名称是否必须说明
Content-typerequired值为:application/json

返回

{ "data":{ "fname":"FNAME", "folderid":FOLDERID }, "result":0}

4, 获取上传文件的链接

获取上传文件的链接

接口说明

获取上传文件的链接

请求说明

[GET] https://openapi.wps.cn/oauthapi/v2/files/upload/url

参数说明

参数参数类型是否必须说明
access_tokenstringrequiredaccess_token
appidstringrequired应用唯一标识
parentidint64required文件夹所在父目录
sizeint64required文件大小
namestringrequired文件名称

Header说明

Header名称是否必须说明
Content-typerequired值为:application/json

返回

{ "result":0, "data":{ "upload_url":"UPLOADURL", "request_header":{ "authorization":"AUTHORIZATION", "date":"DATE", "content_type":"CONTENTTYPE", "x-kss-newfilename-in-body":"XKSSNEWFILENAMEINBODY" } }}

5, 上传文件到金山云

上传文件到金山云

接口说明

上传文件到金山云

请求说明

[PUT] [https://[BUCKET_NAME].ks3-cn-beijing.ksyun.com/[OBJECT_KEY](https://[BUCKET_NAME].ks3-cn-beijing.ksyun.com/[OBJECT_KEY)]

HEADER说明

参数参数类型是否必须说明
datestringrequireddate
x-kss-newfilename-in-bodystringrequiredx-kss-newfilename-in-body
Content-TypestringrequiredContent-Type
authorizationstringrequiredauthorization

BODY说明

上传的文件内容(二进制)

返回

{ "newfilename":"NEWFILENAMESHA1"}

6, 上传文件信息

上传文件信息

接口说明

上传文件信息

请求说明

[POST] https://openapi.wps.cn/oauthapi/v2/files/upload

参数说明

参数参数类型是否必须说明
access_tokenstringrequiredaccess_token
appidstringrequired应用唯一标识
parentidint64required文件夹所在父目录
sizeint64required文件大小
sha1stringrequiredsha1
namestringrequired文件名称

Header说明

Header名称是否必须说明
Content-typerequired值为:application/json

返回

{ "data":{ "fname":"FNAME", "fileid":FILEID }, "result":0}

7, 获取分享文件链接

获取分享文件链接

接口说明

获取分享文件链接

请求说明

[GET] https://openapi.wps.cn/oauthapi/v2/links/url

参数说明

参数参数类型是否必须说明
access_tokenstringrequiredaccess_token
appidstringrequired应用唯一标识
fileidint64required文件id

Header说明

Header名称是否必须说明
Content-typerequired值为:application/json

返回

{ "result":0, "linkurl":"LINKURL", "fname":"FNAME"}

8, 获取文件下载链接

获取文件下载链接

接口说明

获取文件下载链接

请求说明

[GET] https://openapi.wps.cn/oauthapi/v2/appfile/download/url

参数说明

参数参数类型是否必须说明
access_tokenstringrequiredaccess_token
appidstringrequired应用唯一标识
fileidint64required文件id

Header说明

Header名称是否必须说明
Content-typerequired值为:application/json

返回

{ "result":0, "url":"URL"}

9, 文件重命名

文件重命名

接口说明

文件重命名

请求说明

[PUT] https://openapi.wps.cn/oauthapi/v2/appfile/rename

参数说明

参数参数类型是否必须说明
access_tokenstringrequiredaccess_token
appidstringrequired应用唯一标识
fileidint64required文件id
newnamestringrequired新的文件名

Header说明

Header名称是否必须说明
Content-typerequired值为:application/json

返回

{ "result":0 "msg":"success"}

10, 文件复制

文件复制

接口说明

文件复制,只能在本应用文件夹内进行

请求说明

[POST] https://openapi.wps.cn/oauthapi/v2/appfile/copyinapp

参数说明

参数参数类型是否必须说明
access_tokenstringrequiredaccess_token
appidstringrequired应用唯一标识
fileidsstringrequired文件id列表,用,分隔
fromparentidint64required源目录id
toparentidint64required目标目录id

Header说明

Header名称是否必须说明
Content-typerequired值为:application/json

返回

{ "result":0 "msg":"success"}

11, 文件移动

文件移动

接口说明

文件移动,只能在本应用文件夹内进行

请求说明

[POST] https://openapi.wps.cn/oauthapi/v2/appfile/moveinapp

参数说明

参数参数类型是否必须说明
access_tokenstringrequiredaccess_token
appidstringrequired应用唯一标识
fileidsstringrequired文件id列表,用,分隔
fromparentidint64required源目录id
toparentidint64required目标目录id

Header说明

Header名称是否必须说明
Content-typerequired值为:application/json

返回

{ "result":0 "msg":"success"}

12, 文件删除

文件删除

接口说明

文件删除,只能在本应用文件夹内进行

请求说明

[DELETE] https://openapi.wps.cn/oauthapi/v2/appfile/delete

参数说明

参数参数类型是否必须说明
access_tokenstringrequiredaccess_token
appidstringrequired应用唯一标识
fileidsstringrequired文件id列表,用,分隔
parentidint64required文件夹所在父目录

Header说明

Header名称是否必须说明
Content-typerequired值为:application/json

返回

{ "result":0 "msg":"success"}