1. 主页
  2. 文档
  3. 解码器系列设备 HTTP API
  4. 12. users 用户管理模块

12. users 用户管理模块

登陆login

API说明

用户登陆功能。

Request

  • Method: GET/POST
  • URL: users/login.json
  • Headers:
  • 提交参数:
字段 类型 说明
user 字符串 用户名(**必需参数)**
password 字符串 密码(**必需参数)**

Response

  • Body

用户名密码正确返回

{``  "result": "ok",``  "data": {``    "token": "21232f297a57a5a743894a0e4a801fc3",``    "alias": "Admin"``  }``}

登陆失败返回:

{``  "result": "error",``  "msg": "loginError"``}
  • 返回说明:
字段 类型 说明
token 字符串 认证token
alias 字符串 用户昵称

测试接口:

http://192.168.2.123/api/users/login.json?user=admin&password=admin

获取用户列表

API说明

列出当前的HTTP登录用户列表

Request

  • Method: GET/POST
  • URL: users/list.json
  • Headers:
  • 提交参数: 无

Response

  • Body
{``  "result": "ok",``  "data": [``    {``      "role": "admin",``      "id": "admin",``      "create_time": "1970-01-01 00:00:00",``      "alias": "Admin"``    }``  ],``  "count": 1``}

测试接口:

http://192.168.2.123/api/users/list.json

添加用户

API说明

添加HTTP登录用户

Request

  • Method: GET/POST
  • URL: users/add.json
  • Headers:
  • 提交参数:
字段 类型 说明
id 字符串 新用户名(**必需参数)**
alias 字符串 用户昵称(**必需参数)**
password 字符串 密码(**必需参数)**

Response

  • Body
{``  "result": "ok"``}

测试接口:

http://192.168.2.123/api/users/add.json?id=admin1&alias=hahaha&password=test

修改用户信息

API说明

修改HTTP登录用户(的密码/昵称)

Request

  • Method: GET/POST
  • URL: users/modify.json
  • Headers:
  • 提交参数:
字段 类型 说明
id/username 字符串 用户名(**必需参数)**
alias 字符串 用户昵称(**必需参数)**
password 字符串 密码(**必需参数)**

Response

  • Body
{``  "result": "ok"``}

测试接口:

http://192.168.2.123/api/users/modify.json?id=admin&alias=hahaha&password=test111

删除用户

API说明

删除HTTP登录用户

Request

  • Method: GET/POST
  • URL: users/remove.json
  • Headers:
  • 提交参数:
字段 类型 说明
ids 字符串或数组 需要删除的用户名或用户名数组(**必需参数)**

Response

  • Body
{``  "result": "ok"``}

测试接口:

http://192.168.2.123/api/users/remove.json?ids[]=admin1&ids[]=admin122

我们要如何帮助您?