HeyCloud 文档

# 管理员

# 获取管理系统状态

# 请求 URL：

  • http://host:port/heycloud/api/base/admin/status

# 请求方式：

  • GET

# 请求示例：

GET http://host:port/heycloud/api/base/admin/status

# 正确响应示例：

{
  "result": {
    "passwordExists": true
  }
}

# 错误响应示例：

{
  "error": "Error",
  "message": "错误信息"
}

# 初始化密码

  • 初始化管理密码，只有在管理帐号不存在或者当前密码为空时才可以设置

# 请求 URL：

  • http://host:port/heycloud/api/base/admin/initPassword

# 请求方式：

  • POST

# 请求参数:

参数名称 类型 是否必须 默认值 说明
password String 是 - 设置的管理密码，该密码应在前端使用 sha256 进行 hash 计算

# 请求示例：

POST http://host:port/heycloud/api/base/admin/initPassword

{
  "password": "c043ed9f5d4a9a5f8d1680c69ec69c19977bdcbca5030a431c25f4103e920841"
}

# 正确响应示例：

{
  "result": {
    "initedAt": "2021-03-12T01:57:00.390Z"
  }
}

# 错误响应示例：

{
  "error": "PASSWORD_EXISTS",
  "message": "密码已被设置"
}

# 登录验证

# 请求 URL：

  • http://host:port/heycloud/api/base/admin/signin

# 请求方式：

  • POST

# 请求参数:

参数名称 类型 是否必须 默认值 说明
password String 是 - 登录密码，该密码应在前端使用 sha256 进行 hash 计算

# 请求示例：

POST http://host:port/heycloud/api/base/admin/signin

{
  "password": "c043ed9f5d4a9a5f8d1680c69ec69c19977bdcbca5030a431c25f4103e920841"
}

# 正确响应示例：

{
  "result": {
    "session": "mYSnJrJI5Bw0fLACQ6TFptUjRSLnq+OI",
    "signinAt": "2021-03-12T02:37:46.420Z"
  }
}

# 错误响应示例：

{
  "error": "WRONG_PASSWORD",
  "message": "密码不正确"
}

# 安全退出登录

# 请求 URL：

  • http://host:port/heycloud/api/base/admin/signout

# 请求方式：

  • POST

# 请求 Header：

字段 类型 是否必选 说明
x-heycloud-admin-session String 是 根据 session 判断退出账户

# 请求示例：

POST http://host:port/heycloud/api/base/admin/signout

# 正确响应示例：

{
  "result": {
    "signoutAt": "2021-03-12T02:37:45.012Z"
  }
}

# 错误响应示例：

{
  "error": "NO_SESSION",
  "message": "会话不存在"
}

← 底图 →