NiuMall API 文档

认证管理

认证相关接口，用于用户登录获取访问令牌

用户登录

POST /api/auth/login

请求参数

参数名	类型	必填	描述
username	string	是	用户名/手机号/邮箱
password	string	是	密码

请求示例

{"username": "admin", "password": "123456"}

响应示例

{"success": true, "message": "登录成功", "data": {"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "token_type": "Bearer", "expires_in": 86400, "user": {"id": 1, "username": "admin", "email": "admin@example.com", "role": "admin", "status": "active"}}}

响应状态码

200 登录成功

401 用户名或密码错误

403 账户已被禁用

500 服务器内部错误

用户管理

用户相关接口，用于管理系统用户信息

获取用户列表

GET /api/users

查询参数

参数名	类型	必填	描述
page	number	否	页码，默认为1
pageSize	number	否	每页条数，默认为20
keyword	string	否	关键词搜索（用户名、邮箱、手机号）
user_type	string	否	用户类型筛选
status	string	否	用户状态筛选

响应示例

{"success": true, "data": {"items": [{"id": 1, "username": "admin", "email": "admin@example.com", "phone": "13800138000", "user_type": "admin", "status": "active", "createdAt": "2024-01-01T00:00:00Z", "updatedAt": "2024-01-01T00:00:00Z"}], "total": 10, "page": 1, "pageSize": 20, "totalPages": 1}}

获取用户详情

GET /api/users/:id

路径参数

参数名	类型	必填	描述
id	number	是	用户ID

响应示例

{"success": true, "data": {"id": 1, "username": "admin", "email": "admin@example.com", "phone": "13800138000", "user_type": "admin", "status": "active", "createdAt": "2024-01-01T00:00:00Z", "updatedAt": "2024-01-01T00:00:00Z"}}

订单管理

订单相关接口，用于管理商品订单

获取订单列表

GET /api/orders

查询参数

参数名	类型	必填	描述
page	number	否	页码，默认为1
pageSize	number	否	每页条数，默认为20
orderNo	string	否	订单号搜索
buyerId	number	否	买方ID筛选
supplierId	number	否	供应商ID筛选
status	string	否	订单状态筛选

财务管理

财务相关接口，用于管理结算和支付

获取结算列表

GET /api/finance/settlements

查询参数

参数名	类型	必填	描述
page	number	否	页码，默认为1
pageSize	number	否	每页条数，默认为20
keyword	string	否	关键词搜索
paymentStatus	string	否	支付状态筛选

系统接口

系统级接口，用于监控和维护

健康检查

GET /health

响应示例

{"success": true, "message": "服务运行正常", "timestamp": "2025-09-12T04:47:48.209Z", "version": "1.0.0"}