用户与设置相关 API

获取用户信息

接口地址:
  • /api/user/info

HTTP请求方式
  • GET

请求参数
响应代码
  • 共通响应

示例:

curl -X GET "$BASE_URL/api/user/info"

响应示例:

  • JSON:

    {
      "data": { "id": "", "user": "", "name": "", "domain": "" },
      "code": 0,
      "message": "OK"
    }
    

获取用户 ID

接口地址:
  • /api/user/id

HTTP请求方式
  • GET

请求参数
响应代码
  • 共通响应

获取设置详情

接口地址:
  • /api/setting/detail

HTTP请求方式
  • GET

请求参数
响应代码
  • 共通响应

更新设置

接口地址:
  • /api/setting/update

HTTP请求方式
  • POST

请求参数
  • 用户资料字段(name、locale 等,见实现)

响应代码
  • 共通响应

更新密码

接口地址:
  • /api/setting/updatepassword

HTTP请求方式
  • POST

请求参数
  • 原密码、新密码等(见实现)

响应代码
  • 共通响应

上传头像

接口地址:
  • /api/setting/uploadprofileimage

HTTP请求方式
  • POST

请求参数
  • multipart/form-data 上传头像

响应代码
  • 共通响应

更新语言(无需登录)

接口地址:
  • /locale/update

HTTP请求方式
  • POST

请求参数
  • locale (form): 语言标识

响应代码
  • 共通响应

修改密码(API)

接口地址:
  • /api/changepassword

HTTP请求方式
  • POST

请求参数
  • 见实现(修改密码)

响应代码
  • 共通响应

列出应用用户

接口地址:
  • /api/appuser/list

HTTP请求方式
  • GET

请求参数
响应代码
  • 共通响应

创建应用用户

接口地址:
  • /api/appuser/create

HTTP请求方式
  • POST

请求参数
  • 见实现(应用密码/第三方应用账号)

响应代码
  • 共通响应

删除应用用户

接口地址:
  • /api/appuser/delete

HTTP请求方式
  • POST

请求参数
  • id (form, required): 应用用户 ID

响应代码
  • 共通响应

创建规则(收信规则)

接口地址:
  • /api/rule/create

HTTP请求方式
  • POST

请求参数
  • 规则条件、动作等(见实现)

响应代码
  • 共通响应

列出分享

接口地址:
  • /api/share/list/:id

HTTP请求方式
  • GET

请求参数
  • id (path): 分享/文档 ID

响应代码
  • 共通响应

创建分享

接口地址:
  • /api/share/create

HTTP请求方式
  • POST

请求参数
  • 见实现(创建分享链接等)

响应代码
  • 共通响应

更新分享

接口地址:
  • /api/share/update

HTTP请求方式
  • POST

请求参数
  • 见实现

响应代码
  • 共通响应

文档首页列表

接口地址:
  • /api/docshome/list

HTTP请求方式
  • GET

请求参数
响应代码
  • 共通响应

列出目录

接口地址:
  • /api/dots/list

HTTP请求方式
  • GET

请求参数
  • 见实现

响应代码
  • 共通响应

创建目录(文件夹)

接口地址:
  • /api/dots/create

HTTP请求方式
  • POST

请求参数
  • 见实现

响应代码
  • 共通响应

创建目录文件

接口地址:
  • /api/dots/createfile

HTTP请求方式
  • POST

请求参数
  • 见实现

响应代码
  • 共通响应

管理后台 API:获取设置

接口地址:
  • /adminapi/setting

HTTP请求方式
  • GET

请求参数
响应代码
  • common response(需管理员)

管理后台 API:绑定手机号

接口地址:
  • /adminapi/bindmobile

HTTP请求方式
  • POST

请求参数
  • 见实现

响应代码
  • 共通响应

管理后台 API:获取短信验证码

接口地址:
  • /adminapi/getsmscode

HTTP请求方式
  • POST

请求参数
  • 见实现

响应代码
  • 共通响应

创建通知

接口地址:
  • /api/notice/create

HTTP请求方式
  • POST

请求参数
  • 见实现

响应代码
  • 共通响应

模型 API 过滤加密

接口地址:
  • /modelapi/filter/enc

HTTP请求方式
  • GET

请求参数
  • 见实现

响应代码
  • 共通响应