← 返回首页

API模块详情

当前查看模块：memberUser

公共请求头（所有接口适用）

参数名 必填 类型 示例 说明
Authorization 否 string Bearer <JWT token> 用户登录后的 JWT 令牌。若已登录可直接使用，无需传 X-Client。。认证 Token，请在请求头中携带，推荐格式：Bearer {token}
X-Client 否 string <client key token> 客户端密钥。当未携带或无法使用 Authorization 时必填，用于密钥认证。线上文档： http://localhost:5601/docs
X-Site 是 string <site key> 站点标识（必填）。用于切换站点和对应的数据库上下文。所有 OpenAPI 接口必须提供有效的 X-Site header。
X-System-Code 是 string AUTH_MANAGEMENT 系统编码（必填）。用于指定当前访问的业务系统（例如 AUTH_MANAGEMENT、CONTENT_MANAGEMENT）。当系统不支持时将返回“登录用户不支持当前系统，可联系管理员处理”。

会员用户管理

模块标识: memberUser | 接口数量: 5

GET 获取会员用户列表 /api/member-users

查看详情
分页获取会员用户列表
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数
参数名 必填 类型 示例 说明
pageNum 否 number - 页码，默认1
pageSize 否 number - 每页数量，默认10
userId 否 string - 按客户端用户筛选
memberId 否 string - 按会员ID筛选（会员管理记录的_id）
响应示例
{
  "success": {
    "code": "0000",
    "message": "获取成功",
    "data": {
      "list": [
        {
          "id": 1,
          "code": "MU0001",
          "userId": "CU0001",
          "memberId": "xxx",
          "status": 1
        }
      ],
      "total": 100,
      "pageNum": 1,
      "pageSize": 10
    }
  }
}

GET 获取会员用户详情 /api/member-users/{id}

查看详情
根据会员用户ID获取详细信息
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数
参数名 必填 类型 示例 说明
id 是 string - 会员用户ID
响应示例
{
  "success": {
    "code": "0000",
    "message": "获取成功",
    "data": {
      "id": 1,
      "code": "MU0001",
      "userId": "CU0001",
      "memberId": "xxx",
      "status": 1
    }
  },
  "failure": {
    "code": "4040",
    "message": "会员用户不存在",
    "data": null
  }
}

POST 创建会员用户 /api/member-users

查看详情
创建新的会员用户
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数

请求体

{
  "userId": "string｜可选，绑定的客户端用户ID",
  "memberId": "string｜可选，会员ID（会员管理记录的_id），如果提供会校验会员是否存在且有效",
  "status": "number｜可选，状态：1-有效，0-无效"
}

请按照示例结构封装请求体字段，并确保必填字段完整。

响应示例
{
  "success": {
    "code": "0000",
    "message": "创建会员用户成功",
    "data": {
      "id": 1,
      "code": "MU0001",
      "userId": "CU0001",
      "memberId": "xxx",
      "status": 1
    }
  },
  "failure": {
    "code": "4000",
    "message": "关联的会员不存在",
    "data": null
  }
}
注意事项
  • 如果提供了memberId，会校验会员是否存在且有效（status=1），不存在或已停用返回错误：关联的会员不存在或关联的会员已停用

PUT 更新会员用户 /api/member-users/{id}

查看详情
更新指定会员用户的信息
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数
参数名 必填 类型 示例 说明
id 是 string - 会员用户ID

请求体

{
  "userId": "string｜可选，绑定的客户端用户ID",
  "memberId": "string｜可选，会员ID（会员管理记录的_id），如果提供会校验会员是否存在且有效",
  "status": "number｜可选，状态：1-有效，0-无效"
}

请按照示例结构封装请求体字段，并确保必填字段完整。

响应示例
{
  "success": {
    "code": "0000",
    "message": "更新会员用户成功",
    "data": {
      "id": 1,
      "code": "MU0001",
      "userId": "CU0001",
      "memberId": "xxx",
      "status": 1
    }
  },
  "failure": {
    "code": "4000",
    "message": "关联的会员不存在",
    "data": null
  }
}
注意事项
  • 如果提供了memberId，会校验会员是否存在且有效（status=1），不存在或已停用返回错误：关联的会员不存在或关联的会员已停用

DELETE 删除会员用户 /api/member-users/{id}

查看详情
删除指定的会员用户
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数
参数名 必填 类型 示例 说明
id 是 string - 会员用户ID
响应示例
{
  "success": {
    "code": "0000",
    "message": "删除会员用户成功",
    "data": {
      "result": true
    }
  },
  "failure": {
    "code": "4000",
    "message": "删除会员用户失败",
    "data": null
  }
}