400-158-0245

概述

网页与手机端开发

系统架构

网页端开发

手机端开发

常见问题

API接口文档

说明

用户接口

文件核心操作接口

文件管理接口

其它文件操作接口

审批接口

讨论接口

快捷方式/发布接口

消息/提醒接口

多媒体接口

 

用户接口

1、登录接口

URI: /app/user/login

POST参数:

username: 用户登录账户

password: 用户密码

sysytem: 请填写固定值web

返回示例:

{
    "code": 0,
    "customMade": null,
    "data": {
        "auth": 9,
        "bookmarkId": 31,
        "email": "",
        "folderId": 20,
        "maxUsersize": 2147483648,
        "name": "admin",
        "onlyoffice": 1,
        "publishId": 35,
        "realname": "系统管理员",
        "token": "3742f5ef06365e63761f57479f80b0f19aeae62bd2cc274a765edcc0d4b7fb9e186a13",
        "uploaderId": 2039878274,
        "userSize": 0,
        "versionType": 2,
        "webPort": 188
    },
    "hide-person-folder": 0,
    "msg": "登录成功",
    "param": {
        "delnum": "",
        "downnum": "",
        "ip": "",
        "limitdown": "0",
        "limitup": "0",
        "linkdownnum": "",
        "lockTime": "30",
        "maxsyncnum": "6000",
        "media_ext": "mp4 wmv mpg mpeg mov vob mkv ts rmvb rm wmv flv",
        "media_h264": "0",
        "media_open": "0",
        "rootname": "公司文件",
        "searchExt": "doc docx ppt pptx xls xlsx rtf pdf txt",
        "threadnum": "6",
        "upnum": "",
        "viewExt1": "doc docx ppt pptx xls xlsx pps vsd vsdx rtf pdf tif tiff psd ai cdr jpg jpeg bmp png gif txt csv xml htm html log",
        "viewExt2": ""
    },
    "show-comment-num": 0,
    "show-read-num": 0
}

您需要使用json.data.token进行下一步操作

2、移动端登录接口

URI: /app/user/mobile-login

该接口登录后,服务器标识登录的账户是移动端,部分接口(如文件列表接口)针对移动端返回的数据格式会有区别,请仅在开发移动端时使用

POST参数:

username: 登录账户

password: 密码

3、修改密码接口

URI: /app/user/changepwd

POST参数:

token: token参数

oldPwd: 旧的密码

newPwd: 新的密码

注意:如果使用AD域进行登录验证,将无法修改密码

4、用户信息同步接口

URI: /app/user/sync

POST参数:

token: token参数

返回值中的关键信息是:json.login,其值对表意义如下:

0: 账户正常

1、token错误

2、账号被禁用

6、没有访问许可,json.msg给出被限制的原因

另一关键信息是:json.data.noticeNum 与 json.data.noticeMsg,前者表示当前未读消息数量,后者表示最后一条未读消息的内容(如果其值为空,则表示最后一条未读消息已通知到客户端)

5、修改邮箱接口

URI: /app/user/modify-email

POST参数:

token: token参数

pwd: 登录密码

email: 新的邮箱地址

6、获取重置密码页面的URL

URI: /app/user/get-reset-pwd-url

POST参数:

token: token参数

user: 登录账号

ip: 当前云盘服务器的IP或域名,即当前用户正在使用的访问服务器的IP或域名

返回值的:json.url即是重置密码页面的URL,如果用户已绑定邮箱,并且云盘已开启系统邮箱功能,即可通过该页面填写完整的邮箱地址后,在邮箱收到真正的重置密码链接