{ "title": "权限管理系统 - 完整API文档", "version": "1.0.0", "exportTime": "2025-12-07T17:13:10.304Z", "totalModules": 23, "totalApis": 202, "baseUrl": "http://localhost:5600", "description": "基于Express.js + Electron的权限管理系统，支持NeDB和MongoDB双存储模式。支持多站点数据隔离，用户可通过 X-Site header 切换站点和对应的数据库上下文。", "globalHeaders": [ { "name": "Authorization", "type": "string", "required": false, "example": "Bearer ", "description": "用户登录后的 JWT 令牌。若已登录可直接使用，无需传 X-Client。" }, { "name": "X-Client", "type": "string", "required": false, "example": "", "description": "客户端密钥。当未携带或无法使用 Authorization 时必填，用于密钥认证。线上文档： http://localhost:5601/docs" }, { "name": "X-Site", "type": "string", "required": true, "example": "", "description": "站点标识（必填）。用于切换站点和对应的数据库上下文。所有 OpenAPI 接口必须提供有效的 X-Site header。" }, { "name": "X-System-Code", "type": "string", "required": true, "example": "AUTH_MANAGEMENT", "description": "系统编码（必填）。用于指定当前访问的业务系统（例如 AUTH_MANAGEMENT、CONTENT_MANAGEMENT）。当系统不支持时将返回“登录用户不支持当前系统，可联系管理员处理”。" } ], "responseCodes": { "description": "API响应码说明。所有接口统一返回HTTP 200状态码，业务状态通过响应体中的code字段表示。", "successCodes": [ { "code": "0000", "message": "操作成功", "description": "请求处理成功，这是所有成功响应的标准代码" } ], "errorCodes": [ { "code": "1001", "message": "缺少令牌", "description": "请求中缺少必要的令牌（访问令牌、登录令牌、注册令牌等）" }, { "code": "1002", "message": "令牌无效或已过期", "description": "提供的令牌格式错误、无法解析、已过期或信息不完整" }, { "code": "1003", "message": "会员不存在", "description": "指定的会员记录在系统中不存在" }, { "code": "1004", "message": "会员状态无效", "description": "会员状态不是有效状态（非启用状态）" }, { "code": "1005", "message": "会员已过期", "description": "会员的有效期已过" }, { "code": "1006", "message": "系统未开放或已停用", "description": "请求的系统代码对应的系统未启用、不存在或已被停用" }, { "code": "1007", "message": "会员类型未授权当前系统", "description": "当前会员类型未配置访问该系统的权限，或会员码不支持当前系统" }, { "code": "1008", "message": "系统模块未开放访问", "description": "请求的系统模块未启用或不存在" }, { "code": "1009", "message": "会员未开通该功能模块", "description": "会员未开通请求的功能模块" }, { "code": "1010", "message": "当前模块的使用已达到上限", "description": "模块使用次数已达到配置的上限值" }, { "code": "1103", "message": "账号已被加入黑名单", "description": "账号已被加入黑名单，无法执行操作或登录" }, { "code": "1104", "message": "会员类型不存在或已停用", "description": "指定的会员类型不存在或已被停用" }, { "code": "1105", "message": "订单不存在", "description": "指定的订单记录在系统中不存在" }, { "code": "1106", "message": "订单手机号与当前账号不匹配", "description": "订单关联的手机号与当前登录账号的手机号不一致" }, { "code": "1107", "message": "订单尚未支付或已失效", "description": "订单状态不是已支付或已完成状态" }, { "code": "1108", "message": "订单类型与会员类型不匹配", "description": "订单的会员类型与请求的会员类型不一致" }, { "code": "1109", "message": "管理员角色未配置", "description": "系统中未找到管理员角色配置" }, { "code": "1201", "message": "密码需包含字母和数字，且不少于6位", "description": "密码不符合要求：必须包含字母和数字，且长度不少于6位（适用于注册和登录）" }, { "code": "1202", "message": "手机号已注册系统用户", "description": "该手机号已被注册为系统用户" }, { "code": "1203", "message": "公司信用代码已注册", "description": "该公司信用代码已被注册" }, { "code": "1204", "message": "手机号已注册客户端用户", "description": "该手机号已被注册为客户端用户" }, { "code": "1210", "message": "站点标识生成失败，请稍后重试", "description": "生成站点标识时发生错误" }, { "code": "1211", "message": "拒绝无效访问", "description": "站点标识无效或访问被拒绝" }, { "code": "1303", "message": "请同意隐私等协议", "description": "散客账号登录时必须同意隐私协议" }, { "code": "1304", "message": "账号或密码错误", "description": "登录时提供的账号或密码不正确" }, { "code": "1306", "message": "用户未启用或已过期", "description": "用户状态不是启用状态，或用户有效期已过（适用于系统用户和客户端用户）" }, { "code": "1401", "message": "用户不存在", "description": "指定的用户记录在系统中不存在（适用于系统用户和客户端用户）" }, { "code": "1403", "message": "不支持当前系统, 可联系管理员处理", "description": "当前账号不支持访问该系统，需要联系管理员处理" }, { "code": "1500", "message": "接口标识不能为空 / 缺少会员密钥 / 会员密钥无效", "description": "请求中缺少会员密钥，或会员密钥格式错误、无法解析" }, { "code": "1501", "message": "接口未授权或未在系统中配置 / 激活已超时，请重新绑定激活", "description": "接口未授权或未在系统中配置，或激活操作已超时需要重新绑定" }, { "code": "1502", "message": "缺少必要权限", "description": "账号缺少访问资源所需的权限" }, { "code": "1504", "message": "您绑定的会员码无效", "description": "绑定的会员码不存在、状态无效、会员类型无效或已过期" }, { "code": "1505", "message": "传入的会员需要重新绑定", "description": "会员密钥已过期，需要重新绑定激活" }, { "code": "1508", "message": "当前会员不支持当前功能", "description": "会员未开通请求的功能模块" }, { "code": "1509", "message": "缺少功能代码", "description": "请求中缺少必要的功能代码参数" }, { "code": "1999", "message": "权限校验失败", "description": "权限校验过程中发生未预期的错误" }, { "code": "400", "message": "请求参数错误 / 参数验证失败", "description": "请求参数格式错误或验证失败" }, { "code": "401", "message": "未授权访问 / 令牌无效 / 令牌已过期 / 登录失败,用户名或密码错误", "description": "未授权访问，令牌无效或已过期，或登录凭据错误" }, { "code": "403", "message": "禁止访问", "description": "账号没有权限访问该资源" }, { "code": "404", "message": "资源不存在", "description": "请求的资源在系统中不存在" }, { "code": "405", "message": "此接口仅支持 POST 方法，请使用 POST 请求", "description": "请求方法不正确，该接口仅支持POST方法" }, { "code": "409", "message": "资源冲突 / 数据已存在", "description": "创建的资源已存在，或数据冲突" }, { "code": "429", "message": "请求过于频繁，请稍后再试", "description": "请求频率超过限制，需要稍后重试" }, { "code": "500", "message": "操作失败 / 服务器内部错误 / 数据库操作失败", "description": "服务器内部错误，操作失败或数据库操作异常" } ] }, "modules": [ { "module": "用户管理", "moduleKey": "user", "apiCount": 5, "apis": [ { "title": "获取用户列表", "method": "GET", "path": "/api/users", "description": "分页获取系统用户列表，支持按姓名、手机号、状态筛选。支持通过 X-Site header 切换站点，切换后查询对应站点的数据库。", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "用户姓名（模糊搜索）" }, { "name": "phone", "type": "string", "required": false, "description": "手机号（模糊搜索）" }, { "name": "status", "type": "number", "required": false, "description": "状态：1-正常，0-禁用" } ] }, "responseExample": { "success": { "code": 200, "message": "获取成功", "data": { "list": [ { "id": 1, "code": "USER001", "name": "张三", "title": "系统管理员", "phone": "13800138000", "email": "zhangsan@example.com", "phonePrefix": "+86", "status": 1, "createTime": "2024-01-01T00:00:00.000Z" } ], "total": 100, "pageNum": 1, "pageSize": 10 } } } }, { "title": "获取用户详情", "method": "GET", "path": "/api/users/{id}", "description": "根据用户ID获取用户详细信息", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "系统用户ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "USER0001", "name": "系统管理员", "phone": "13800000000", "status": 1, "roles": [ "ROLE0001" ], "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4040", "message": "系统用户不存在", "data": null } } }, { "title": "创建用户", "method": "POST", "path": "/api/users", "description": "创建新的系统用户", "requestParams": { "body": { "name": "string｜必填，用户姓名", "phone": "string｜必填，手机号，唯一", "password": "string｜必填，登录密码", "roles": "array｜可选，绑定角色ID数组", "status": "number｜可选，状态：1-启用，0-禁用" } }, "responseExample": { "success": { "code": "0000", "message": "创建系统用户成功", "data": { "id": 1, "code": "USER0001", "name": "系统管理员", "phone": "13800000000", "status": 1, "roles": [ "ROLE0001" ], "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "创建系统用户失败", "data": null } } }, { "title": "更新用户", "method": "PUT", "path": "/api/users/{id}", "description": "更新指定用户的信息", "requestParams": { "body": { "name": "string｜必填，用户姓名", "phone": "string｜必填，手机号，唯一", "password": "string｜必填，登录密码", "roles": "array｜可选，绑定角色ID数组", "status": "number｜可选，状态：1-启用，0-禁用" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "系统用户ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新系统用户成功", "data": { "id": 1, "code": "USER0001", "name": "系统管理员", "phone": "13800000000", "status": 1, "roles": [ "ROLE0001" ], "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "更新系统用户失败", "data": null } } }, { "title": "删除用户", "method": "DELETE", "path": "/api/users/{id}", "description": "删除指定的用户", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "系统用户ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除系统用户成功", "data": { "result": true } }, "failure": { "code": "4000", "message": "删除系统用户失败", "data": null } } } ] }, { "module": "认证模块", "moduleKey": "auth", "apiCount": 4, "apis": [ { "title": "用户注册", "method": "POST", "path": "/auth/register", "description": "系统用户注册接口。如果 individualism=true，会为用户创建独立站点和独立数据库，并自动创建超级管理员角色。", "requestParams": { "body": { "name": "string｜必填，用户名", "phone": "string｜必填，手机号", "password": "string｜必填，登录密码", "email": "string｜可选，邮箱", "individualism": "boolean｜可选，是否创建独立站点，默认 false" } }, "responseExample": { "success": { "code": "0000", "message": "注册成功", "data": { "token": "jwt-token", "user": { "id": "USER0001", "code": "USER000001", "name": "张三", "phone": "13800138000", "email": "zhangsan@example.com", "individualism": true, "individualDbName": "user_1_1764407777204" }, "clientKey": { "id": "key-id", "keyToken": "key-token", "individualDbName": "user_1_1764407777204" } } }, "failure": { "code": "4000", "message": "注册失败", "data": null } }, "notes": [ "如果 individualism=true，系统会：1. 创建独立数据库 2. 在独立数据库中创建用户副本 3. 创建超级管理员角色并绑定用户", "注册成功后，用户记录在所属站点数据库创建，同时在独立数据库中创建副本用于角色绑定" ] }, { "title": "用户登录", "method": "POST", "path": "/auth/login", "description": "系统用户登录接口。如果用户有多个可用站点，会返回站点列表供前端选择。", "requestParams": { "headers": [ { "name": "system", "type": "string", "required": false, "description": "系统编码，登录时自动分配系统默认管理员角色" } ], "body": { "phone": "string｜必填，手机号", "password": "string｜必填，登录密码" } }, "responseExample": { "success": { "code": "0000", "message": "登录成功", "data": { "token": "jwt-token", "user": { "id": "USER0001", "code": "USER000001", "username": "系统管理员", "phone": "13800138000", "email": "admin@example.com", "individualism": true, "individualDbName": "user_1_1764407777204", "status": 1, "createTime": "2025-01-21T10:00:00.000Z", "accountType": "user", "type": "普通用户" }, "availableSites": [ { "siteKey": "56B57A72-59C4-460B-82E5-22196205391B-A4608B6E9D4D6F599", "name": "所属站点", "type": "owner", "isDefault": true }, { "siteKey": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890-ABCDEF12", "name": "个人站点", "type": "personal", "isDefault": false } ] } }, "failure": { "code": "4000", "message": "登录失败", "data": null } }, "notes": [ "如果用户有独立站点，availableSites 会包含两个站点：所属站点（type: owner）和个人站点（type: personal）", "前端可以通过 X-Site header 切换站点，切换后所有 API 请求将使用对应站点的数据库", "默认使用所属站点（isDefault: true），如需切换到个人站点，在后续请求中传递个人站点的 siteKey" ] }, { "title": "客户端用户注册", "method": "POST", "path": "/auth/client/register", "description": "客户端用户注册接口。如果 individualism=true，会为用户创建独立站点和独立数据库，并自动创建超级管理员角色。", "requestParams": { "body": { "name": "string｜可选，客户端用户姓名，默认为'游客'", "phone": "string｜必填，手机号", "password": "string｜必填，登录密码", "email": "string｜可选，邮箱", "agreeTerms": "boolean｜必填，是否同意协议", "individualism": "boolean｜可选，是否创建独立站点，默认 false" } }, "responseExample": { "success": { "code": "0000", "message": "注册成功", "data": { "token": "jwt-token", "user": { "id": "CU0001", "code": "CU000001", "username": "客户端用户", "phone": "13800138000", "email": "user@example.com", "individualism": true, "individualDbName": "client_user_1_1764407777204" }, "clientKey": { "id": "key-id", "keyToken": "key-token", "individualDbName": "client_user_1_1764407777204" } } }, "failure": { "code": "4000", "message": "注册失败", "data": null } }, "notes": [ "如果 individualism=true，系统会：1. 创建独立数据库 2. 在独立数据库中创建用户副本 3. 创建超级管理员角色并绑定用户", "注册成功后，用户记录在所属站点数据库创建，同时在独立数据库中创建副本用于角色绑定" ] }, { "title": "客户端用户登录", "method": "POST", "path": "/auth/client/login", "description": "客户端用户登录接口。如果用户有多个可用站点，会返回站点列表供前端选择。", "requestParams": { "headers": [ { "name": "system", "type": "string", "required": false, "description": "系统编码，登录时自动分配系统默认管理员角色" } ], "body": { "phone": "string｜必填，手机号", "password": "string｜必填，登录密码", "agreeTerms": "boolean｜必填，是否同意协议" } }, "responseExample": { "success": { "code": "0000", "message": "登录成功", "data": { "token": "jwt-token", "user": { "id": "CU0001", "code": "CU000001", "username": "客户端管理员", "phone": "13800138000", "email": "client@example.com", "individualism": true, "individualDbName": "client_user_1_1764407777204", "status": 1, "createTime": "2025-01-21T10:00:00.000Z", "accountType": "clientUser", "type": "散客" }, "availableSites": [ { "siteKey": "56B57A72-59C4-460B-82E5-22196205391B-A4608B6E9D4D6F599", "name": "所属站点", "type": "owner", "isDefault": true }, { "siteKey": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890-ABCDEF12", "name": "个人站点", "type": "personal", "isDefault": false } ] } }, "failure": { "code": "4000", "message": "登录失败", "data": null } }, "notes": [ "如果用户有独立站点，availableSites 会包含两个站点：所属站点（type: owner）和个人站点（type: personal）", "前端可以通过 X-Site header 切换站点，切换后所有 API 请求将使用对应站点的数据库", "默认使用所属站点（isDefault: true），如需切换到个人站点，在后续请求中传递个人站点的 siteKey" ] } ] }, { "module": "系统管理", "moduleKey": "system", "apiCount": 5, "apis": [ { "title": "业务开通", "method": "POST", "path": "/system/business/activate", "description": "业务开通接口", "requestParams": { "body": { "systemCode": "string｜必填，要开通的系统编码", "expireDays": "number｜可选，业务有效天数" } }, "responseExample": { "success": { "code": "0000", "message": "业务开通成功", "data": { "systemCode": "AUTH", "activated": true } }, "failure": { "code": "4000", "message": "业务开通失败", "data": null } }, "notes": [ "需管理员身份调用" ] }, { "title": "用户存储模式切换", "method": "POST", "path": "/system/storage/switch", "description": "用户存储模式切换功能", "requestParams": { "body": { "mode": "string｜必填，目标存储模式，可选 'FILE' 或 'CLOUD'" } }, "responseExample": { "success": { "code": "0000", "message": "切换存储模式成功", "data": { "mode": "FILE" } }, "failure": { "code": "4000", "message": "切换存储模式失败", "data": null } }, "notes": [ "切换后会自动重启数据源，请确保备份" ] }, { "title": "客户端用户存储模式切换", "method": "POST", "path": "/system/storage/client/switch", "description": "客户端用户存储模式切换功能", "requestParams": { "body": { "mode": "string｜必填，目标存储模式，可选 'FILE' 或 'CLOUD'" } }, "responseExample": { "success": { "code": "0000", "message": "切换客户端用户存储模式成功", "data": { "mode": "FILE" } }, "failure": { "code": "4000", "message": "切换客户端用户存储模式失败", "data": null } } }, { "title": "获取存储模式", "method": "GET", "path": "/system/storage/mode", "description": "获取当前存储模式", "requestParams": {}, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "userMode": "FILE", "clientUserMode": "FILE" } } } }, { "title": "系统信息", "method": "GET", "path": "/system/info", "description": "获取系统基本信息", "requestParams": {}, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "version": "1.0.0", "buildTime": "2025-01-01T10:00:00.000Z", "storageMode": "FILE" } } } } ] }, { "module": "客户端用户管理", "moduleKey": "clientUser", "apiCount": 5, "apis": [ { "title": "获取客户端用户列表", "method": "GET", "path": "/api/client-users", "description": "分页获取客户端用户列表", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "姓名关键词" }, { "name": "phone", "type": "string", "required": false, "description": "手机号" }, { "name": "status", "type": "number", "required": false, "description": "状态过滤" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "code": "CU0001", "name": "客户端管理员", "phone": "13900000000", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } ], "total": 100, "pageNum": 1, "pageSize": 10 } } } }, { "title": "获取客户端用户详情", "method": "GET", "path": "/api/client-users/{id}", "description": "根据客户端用户ID获取详细信息", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "客户端用户ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "CU0001", "name": "客户端管理员", "phone": "13900000000", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4040", "message": "客户端用户不存在", "data": null } } }, { "title": "创建客户端用户", "method": "POST", "path": "/api/client-users", "description": "创建新的客户端用户", "requestParams": { "body": { "name": "string｜必填，客户端用户姓名", "phone": "string｜必填，手机号，唯一", "password": "string｜必填，登录密码", "status": "number｜可选，状态：1-启用，0-禁用" } }, "responseExample": { "success": { "code": "0000", "message": "创建客户端用户成功", "data": { "id": 1, "code": "CU0001", "name": "客户端管理员", "phone": "13900000000", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "创建客户端用户失败", "data": null } } }, { "title": "更新客户端用户", "method": "PUT", "path": "/api/client-users/{id}", "description": "更新指定客户端用户的信息", "requestParams": { "body": { "name": "string｜必填，客户端用户姓名", "phone": "string｜必填，手机号，唯一", "password": "string｜必填，登录密码", "status": "number｜可选，状态：1-启用，0-禁用" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "客户端用户ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新客户端用户成功", "data": { "id": 1, "code": "CU0001", "name": "客户端管理员", "phone": "13900000000", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "更新客户端用户失败", "data": null } } }, { "title": "删除客户端用户", "method": "DELETE", "path": "/api/client-users/{id}", "description": "删除指定的客户端用户", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "客户端用户ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除客户端用户成功", "data": { "result": true } }, "failure": { "code": "4000", "message": "删除客户端用户失败", "data": null } } } ] }, { "module": "组织管理", "moduleKey": "organization", "apiCount": 7, "apis": [ { "title": "获取组织列表", "method": "GET", "path": "/api/organizations", "description": "获取组织列表，支持树形结构", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "组织名称关键词" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "code": "ORG0001", "name": "总部", "parentId": null, "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } ], "total": 100, "pageNum": 1, "pageSize": 10 } } } }, { "title": "获取组织详情", "method": "GET", "path": "/api/organizations/{id}", "description": "根据组织ID获取组织详细信息", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "组织ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "ORG0001", "name": "总部", "parentId": null, "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4040", "message": "组织不存在", "data": null } } }, { "title": "创建组织", "method": "POST", "path": "/api/organizations", "description": "创建新的组织", "requestParams": { "body": { "name": "string｜必填，组织名称", "parentId": "string｜可选，父级组织ID，根节点为空", "status": "number｜可选，状态：1-启用，0-禁用" } }, "responseExample": { "success": { "code": "0000", "message": "创建组织成功", "data": { "id": 1, "code": "ORG0001", "name": "总部", "parentId": null, "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "创建组织失败", "data": null } } }, { "title": "更新组织", "method": "PUT", "path": "/api/organizations/{id}", "description": "更新指定组织的信息", "requestParams": { "body": { "name": "string｜必填，组织名称", "parentId": "string｜可选，父级组织ID，根节点为空", "status": "number｜可选，状态：1-启用，0-禁用" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "组织ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新组织成功", "data": { "id": 1, "code": "ORG0001", "name": "总部", "parentId": null, "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "更新组织失败", "data": null } } }, { "title": "删除组织", "method": "DELETE", "path": "/api/organizations/{id}", "description": "删除指定的组织", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "组织ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除组织成功", "data": { "result": true } }, "failure": { "code": "4000", "message": "删除组织失败", "data": null } } }, { "title": "获取组织关联用户", "method": "GET", "path": "/api/organizations/{id}/users", "description": "获取指定组织关联的用户", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "组织ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "ORG0001", "name": "总部", "parentId": null, "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4040", "message": "组织不存在", "data": null } } }, { "title": "更新组织用户关联", "method": "PUT", "path": "/api/organizations/{id}/users", "description": "更新指定组织的用户关联关系", "requestParams": { "body": { "name": "string｜必填，组织名称", "parentId": "string｜可选，父级组织ID，根节点为空", "status": "number｜可选，状态：1-启用，0-禁用" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "组织ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新组织成功", "data": { "id": 1, "code": "ORG0001", "name": "总部", "parentId": null, "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "更新组织失败", "data": null } } } ] }, { "module": "部门管理", "moduleKey": "department", "apiCount": 7, "apis": [ { "title": "获取部门列表", "method": "GET", "path": "/api/departments", "description": "获取部门列表，支持按组织筛选", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "organizationId", "type": "string", "required": false, "description": "按组织筛选" }, { "name": "name", "type": "string", "required": false, "description": "部门名称关键词" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "code": "DEP0001", "name": "研发部", "organizationId": "ORG0001", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } ], "total": 100, "pageNum": 1, "pageSize": 10 } } } }, { "title": "获取部门详情", "method": "GET", "path": "/api/departments/{id}", "description": "根据部门ID获取部门详细信息", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "部门ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "DEP0001", "name": "研发部", "organizationId": "ORG0001", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4040", "message": "部门不存在", "data": null } } }, { "title": "创建部门", "method": "POST", "path": "/api/departments", "description": "创建新的部门", "requestParams": { "body": { "name": "string｜必填，部门名称", "organizationId": "string｜必填，所属组织ID", "leaderId": "string｜可选，部门负责人ID", "status": "number｜可选，状态：1-启用，0-禁用" } }, "responseExample": { "success": { "code": "0000", "message": "创建部门成功", "data": { "id": 1, "code": "DEP0001", "name": "研发部", "organizationId": "ORG0001", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "创建部门失败", "data": null } } }, { "title": "更新部门", "method": "PUT", "path": "/api/departments/{id}", "description": "更新指定部门的信息", "requestParams": { "body": { "name": "string｜必填，部门名称", "organizationId": "string｜必填，所属组织ID", "leaderId": "string｜可选，部门负责人ID", "status": "number｜可选，状态：1-启用，0-禁用" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "部门ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新部门成功", "data": { "id": 1, "code": "DEP0001", "name": "研发部", "organizationId": "ORG0001", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "更新部门失败", "data": null } } }, { "title": "删除部门", "method": "DELETE", "path": "/api/departments/{id}", "description": "删除指定的部门", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "部门ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除部门成功", "data": { "result": true } }, "failure": { "code": "4000", "message": "删除部门失败", "data": null } } }, { "title": "获取部门关联用户", "method": "GET", "path": "/api/departments/{id}/users", "description": "获取指定部门关联的用户", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "部门ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "DEP0001", "name": "研发部", "organizationId": "ORG0001", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4040", "message": "部门不存在", "data": null } } }, { "title": "更新部门用户关联", "method": "PUT", "path": "/api/departments/{id}/users", "description": "更新指定部门的用户关联关系", "requestParams": { "body": { "name": "string｜必填，部门名称", "organizationId": "string｜必填，所属组织ID", "leaderId": "string｜可选，部门负责人ID", "status": "number｜可选，状态：1-启用，0-禁用" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "部门ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新部门成功", "data": { "id": 1, "code": "DEP0001", "name": "研发部", "organizationId": "ORG0001", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "更新部门失败", "data": null } } } ] }, { "module": "岗位管理", "moduleKey": "position", "apiCount": 7, "apis": [ { "title": "获取岗位列表", "method": "GET", "path": "/api/positions", "description": "分页获取岗位列表", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "岗位名称关键词" }, { "name": "status", "type": "number", "required": false, "description": "状态过滤" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "code": "POS0001", "name": "产品经理", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } ], "total": 100, "pageNum": 1, "pageSize": 10 } } } }, { "title": "获取岗位详情", "method": "GET", "path": "/api/positions/{id}", "description": "根据岗位ID获取岗位详细信息", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "岗位ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "POS0001", "name": "产品经理", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4040", "message": "岗位不存在", "data": null } } }, { "title": "创建岗位", "method": "POST", "path": "/api/positions", "description": "创建新的岗位", "requestParams": { "body": { "name": "string｜必填，岗位名称", "organizationId": "string｜可选，所属组织ID", "status": "number｜可选，状态：1-启用，0-禁用" } }, "responseExample": { "success": { "code": "0000", "message": "创建岗位成功", "data": { "id": 1, "code": "POS0001", "name": "产品经理", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "创建岗位失败", "data": null } } }, { "title": "更新岗位", "method": "PUT", "path": "/api/positions/{id}", "description": "更新指定岗位的信息", "requestParams": { "body": { "name": "string｜必填，岗位名称", "organizationId": "string｜可选，所属组织ID", "status": "number｜可选，状态：1-启用，0-禁用" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "岗位ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新岗位成功", "data": { "id": 1, "code": "POS0001", "name": "产品经理", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "更新岗位失败", "data": null } } }, { "title": "删除岗位", "method": "DELETE", "path": "/api/positions/{id}", "description": "删除指定的岗位", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "岗位ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除岗位成功", "data": { "result": true } }, "failure": { "code": "4000", "message": "删除岗位失败", "data": null } } }, { "title": "获取岗位关联用户", "method": "GET", "path": "/api/positions/{id}/users", "description": "获取指定岗位关联的用户", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "岗位ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "POS0001", "name": "产品经理", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4040", "message": "岗位不存在", "data": null } } }, { "title": "更新岗位用户关联", "method": "PUT", "path": "/api/positions/{id}/users", "description": "更新指定岗位的用户关联关系", "requestParams": { "body": { "name": "string｜必填，岗位名称", "organizationId": "string｜可选，所属组织ID", "status": "number｜可选，状态：1-启用，0-禁用" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "岗位ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新岗位成功", "data": { "id": 1, "code": "POS0001", "name": "产品经理", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "更新岗位失败", "data": null } } } ] }, { "module": "职员管理", "moduleKey": "staff", "apiCount": 5, "apis": [ { "title": "获取职员列表", "method": "GET", "path": "/api/staff", "description": "获取职员列表，支持按部门筛选", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "organizationId", "type": "string", "required": false, "description": "所属组织筛选" }, { "name": "name", "type": "string", "required": false, "description": "姓名关键词" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "code": "STA0001", "name": "张三", "phone": "13800000001", "organizationId": "ORG0001", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } ], "total": 100, "pageNum": 1, "pageSize": 10 } } } }, { "title": "获取职员详情", "method": "GET", "path": "/api/staff/{id}", "description": "根据职员ID获取职员详细信息", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "职员ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "STA0001", "name": "张三", "phone": "13800000001", "organizationId": "ORG0001", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4040", "message": "职员不存在", "data": null } } }, { "title": "创建职员", "method": "POST", "path": "/api/staff", "description": "创建新的职员", "requestParams": { "body": { "name": "string｜必填，职员姓名", "phone": "string｜必填，手机号", "organizationId": "string｜必填，所属组织ID", "status": "number｜可选，状态：1-在职，0-离职" } }, "responseExample": { "success": { "code": "0000", "message": "创建职员成功", "data": { "id": 1, "code": "STA0001", "name": "张三", "phone": "13800000001", "organizationId": "ORG0001", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "创建职员失败", "data": null } } }, { "title": "更新职员", "method": "PUT", "path": "/api/staff/{id}", "description": "更新指定职员的信息", "requestParams": { "body": { "name": "string｜必填，职员姓名", "phone": "string｜必填，手机号", "organizationId": "string｜必填，所属组织ID", "status": "number｜可选，状态：1-在职，0-离职" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "职员ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新职员成功", "data": { "id": 1, "code": "STA0001", "name": "张三", "phone": "13800000001", "organizationId": "ORG0001", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "更新职员失败", "data": null } } }, { "title": "删除职员", "method": "DELETE", "path": "/api/staff/{id}", "description": "删除指定的职员", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "职员ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除职员成功", "data": { "result": true } }, "failure": { "code": "4000", "message": "删除职员失败", "data": null } } } ] }, { "module": "角色管理", "moduleKey": "role", "apiCount": 7, "apis": [ { "title": "获取角色列表", "method": "GET", "path": "/api/roles", "description": "分页获取角色列表", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "角色名称关键词" }, { "name": "code", "type": "string", "required": false, "description": "角色编码" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "code": "ROLE0001", "name": "系统管理员", "status": 1, "permissions": [ "PERM0001" ], "resources": [ "RES0001" ] } ], "total": 100, "pageNum": 1, "pageSize": 10 } } } }, { "title": "获取角色详情", "method": "GET", "path": "/api/roles/{id}", "description": "根据角色ID获取角色详细信息", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "角色ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "ROLE0001", "name": "系统管理员", "status": 1, "permissions": [ "PERM0001" ], "resources": [ "RES0001" ] } }, "failure": { "code": "4040", "message": "角色不存在", "data": null } } }, { "title": "创建角色", "method": "POST", "path": "/api/roles", "description": "创建新的角色", "requestParams": { "body": { "name": "string｜必填，角色名称", "code": "string｜必填，角色编码，唯一", "status": "number｜可选，状态：1-启用，0-禁用" } }, "responseExample": { "success": { "code": "0000", "message": "创建角色成功", "data": { "id": 1, "code": "ROLE0001", "name": "系统管理员", "status": 1, "permissions": [ "PERM0001" ], "resources": [ "RES0001" ] } }, "failure": { "code": "4000", "message": "创建角色失败", "data": null } } }, { "title": "更新角色", "method": "PUT", "path": "/api/roles/{id}", "description": "更新指定角色的信息", "requestParams": { "body": { "name": "string｜必填，角色名称", "code": "string｜必填，角色编码，唯一", "status": "number｜可选，状态：1-启用，0-禁用" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "角色ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新角色成功", "data": { "id": 1, "code": "ROLE0001", "name": "系统管理员", "status": 1, "permissions": [ "PERM0001" ], "resources": [ "RES0001" ] } }, "failure": { "code": "4000", "message": "更新角色失败", "data": null } } }, { "title": "删除角色", "method": "DELETE", "path": "/api/roles/{id}", "description": "删除指定的角色", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "角色ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除角色成功", "data": { "result": true } }, "failure": { "code": "4000", "message": "删除角色失败", "data": null } } }, { "title": "绑定角色权限", "method": "PUT", "path": "/api/roles/{id}/permissions", "description": "为指定角色绑定权限", "requestParams": { "body": { "name": "string｜必填，角色名称", "code": "string｜必填，角色编码，唯一", "status": "number｜可选，状态：1-启用，0-禁用" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "角色ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新角色成功", "data": { "id": 1, "code": "ROLE0001", "name": "系统管理员", "status": 1, "permissions": [ "PERM0001" ], "resources": [ "RES0001" ] } }, "failure": { "code": "4000", "message": "更新角色失败", "data": null } } }, { "title": "绑定角色资源", "method": "PUT", "path": "/api/roles/{id}/resources", "description": "为指定角色绑定资源", "requestParams": { "body": { "name": "string｜必填，角色名称", "code": "string｜必填，角色编码，唯一", "status": "number｜可选，状态：1-启用，0-禁用" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "角色ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新角色成功", "data": { "id": 1, "code": "ROLE0001", "name": "系统管理员", "status": 1, "permissions": [ "PERM0001" ], "resources": [ "RES0001" ] } }, "failure": { "code": "4000", "message": "更新角色失败", "data": null } } } ] }, { "module": "权限管理", "moduleKey": "permission", "apiCount": 5, "apis": [ { "title": "获取权限列表", "method": "GET", "path": "/api/permissions", "description": "分页获取权限列表", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "权限名称关键词" }, { "name": "code", "type": "string", "required": false, "description": "权限编码" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "code": "PERM0001", "name": "用户管理", "type": "menu", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } ], "total": 100, "pageNum": 1, "pageSize": 10 } } } }, { "title": "获取权限详情", "method": "GET", "path": "/api/permissions/{id}", "description": "根据权限ID获取权限详细信息", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "权限ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "PERM0001", "name": "用户管理", "type": "menu", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4040", "message": "权限不存在", "data": null } } }, { "title": "创建权限", "method": "POST", "path": "/api/permissions", "description": "创建新的权限", "requestParams": { "body": { "name": "string｜必填，权限名称", "code": "string｜必填，权限编码，唯一", "type": "string｜可选，权限类型，例如menu/button", "status": "number｜可选，状态：1-启用，0-禁用" } }, "responseExample": { "success": { "code": "0000", "message": "创建权限成功", "data": { "id": 1, "code": "PERM0001", "name": "用户管理", "type": "menu", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "创建权限失败", "data": null } } }, { "title": "更新权限", "method": "PUT", "path": "/api/permissions/{id}", "description": "更新指定权限的信息", "requestParams": { "body": { "name": "string｜必填，权限名称", "code": "string｜必填，权限编码，唯一", "type": "string｜可选，权限类型，例如menu/button", "status": "number｜可选，状态：1-启用，0-禁用" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "权限ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新权限成功", "data": { "id": 1, "code": "PERM0001", "name": "用户管理", "type": "menu", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "更新权限失败", "data": null } } }, { "title": "删除权限", "method": "DELETE", "path": "/api/permissions/{id}", "description": "删除指定的权限", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "权限ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除权限成功", "data": { "result": true } }, "failure": { "code": "4000", "message": "删除权限失败", "data": null } } } ] }, { "module": "资源管理", "moduleKey": "resource", "apiCount": 6, "apis": [ { "title": "查询所有有效资源", "method": "GET", "path": "/api/resources/active", "description": "查询所有有效的资源配置列表，用于其他业务通过选择列表选择目标资源。返回所有 status = 1 的资源，不需要分页。支持通过 systemId 查询指定系统的资源。支持通过 X-Site header 切换站点，切换后查询对应站点的数据库。", "requestParams": { "query": [ { "name": "systemId", "type": "string", "required": false, "description": "所属系统ID，用于过滤资源所属系统。不传则返回所有系统的有效资源" }, { "name": "moduleId", "type": "string", "required": false, "description": "关联模块ID（可选）。传入时需与 systemId 搭配，用于按模块过滤资源" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": [ { "id": 1, "code": "RES0001", "name": "用户列表", "title": "用户列表", "systemId": "系统ID", "systemName": "权限管理系统", "type": "page", "url": "/users", "status": 1, "parentId": null, "moduleId": "AUTH_USER", "orderNum": 1, "createTime": "2025-01-01T10:00:00.000Z" }, { "id": 2, "code": "RES0002", "name": "角色管理", "title": "角色管理", "systemId": "系统ID", "systemName": "权限管理系统", "type": "page", "url": "/roles", "status": 1, "parentId": null, "moduleId": "AUTH_ROLE", "orderNum": 2, "createTime": "2025-01-01T11:00:00.000Z" } ] } }, "notes": [ "仅返回 status = 1 的有效资源", "按 orderNum 和 createTime 排序", "不需要分页，返回完整列表", "支持通过 systemId 查询参数过滤指定系统的资源", "支持通过 moduleId 查询参数过滤指定模块资源（需同时传 systemId）", "也支持通过路径参数 systemId 查询（如 /api/security/systems/{systemId}/resources/active）" ] }, { "title": "获取资源列表", "method": "GET", "path": "/api/resources", "description": "分页获取资源列表，支持按名称、类型、系统筛选。支持通过 X-Site header 切换站点，切换后查询对应站点的数据库。", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "资源名称关键词" }, { "name": "code", "type": "string", "required": false, "description": "资源编码" }, { "name": "type", "type": "string", "required": false, "description": "资源类型" }, { "name": "systemId", "type": "string", "required": false, "description": "所属系统ID，用于过滤资源所属系统" }, { "name": "moduleId", "type": "string", "required": false, "description": "关联模块ID（可选）。传入时需与 systemId 搭配，用于按模块过滤资源" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "code": "RES0001", "name": "用户列表", "systemId": "AUTH", "systemName": "权限管理系统", "type": "page", "url": "/users", "status": 1, "parentId": null, "moduleId": "AUTH_USER", "orderNum": 10 } ], "total": 100, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "列表结果固定按 orderNum 升序，其次按 createTime 倒序", "orderNum 越小，菜单同级显示越靠前" ] }, { "title": "获取资源详情", "method": "GET", "path": "/api/resources/{id}", "description": "根据资源ID获取资源详细信息", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "资源ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "RES0001", "name": "用户列表", "systemId": "AUTH", "systemName": "权限管理系统", "type": "page", "url": "/users", "status": 1, "parentId": null, "moduleId": "AUTH_USER", "orderNum": 10 } }, "failure": { "code": "4040", "message": "资源不存在", "data": null } } }, { "title": "创建资源", "method": "POST", "path": "/api/resources", "description": "创建新的资源", "requestParams": { "body": { "name": "string｜必填，资源名称", "systemId": "string｜必填，所属系统ID，用于绑定资源所属系统", "type": "string｜必填，资源类型，例如page/api/button", "url": "string｜必填，资源URL，用于路由或接口地址", "status": "number｜可选，状态：1-启用，0-禁用", "parentId": "string｜可选，父级资源ID，用于构建资源树状结构，不传或传空则为根节点", "moduleId": "string｜可选，关联模块ID，可为空（推荐与systemId保持一致）", "orderNum": "number｜可选，排序序号（同级内升序），默认0" } }, "responseExample": { "success": { "code": "0000", "message": "创建资源成功", "data": { "id": 1, "code": "RES0001", "name": "用户列表", "systemId": "AUTH", "systemName": "权限管理系统", "type": "page", "url": "/users", "status": 1, "parentId": null, "moduleId": "AUTH_USER", "orderNum": 10 } }, "failure": { "code": "4000", "message": "创建资源失败", "data": null } }, "notes": [ "code 由系统自动生成，无需传入", "moduleId 可为空；若传入，需为该 systemId 下有效模块", "orderNum 用于菜单树同级排序，值越小越靠前" ] }, { "title": "更新资源", "method": "PUT", "path": "/api/resources/{id}", "description": "更新指定资源的信息", "requestParams": { "body": { "name": "string｜必填，资源名称", "systemId": "string｜可选，所属系统ID，不传则保持原值", "type": "string｜必填，资源类型，例如page/api/button", "url": "string｜必填，资源URL，用于路由或接口地址", "status": "number｜可选，状态：1-启用，0-禁用", "parentId": "string｜可选，父级资源ID，用于构建资源树状结构，不传或传空则为根节点", "moduleId": "string｜可选，关联模块ID；传空字符串或null可清空关联", "orderNum": "number｜可选，排序序号（同级内升序），不传则保持原值" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "资源ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新资源成功", "data": { "id": 1, "code": "RES0001", "name": "用户列表", "systemId": "AUTH", "systemName": "权限管理系统", "type": "page", "url": "/users", "status": 1, "parentId": null, "moduleId": "AUTH_USER", "orderNum": 20 } }, "failure": { "code": "4000", "message": "更新资源失败", "data": null } }, "notes": [ "moduleId 为可选字段，可配置/修改/清空模块关联", "更新 orderNum 后，菜单树同级排序会按新序号生效" ] }, { "title": "删除资源", "method": "DELETE", "path": "/api/resources/{id}", "description": "删除指定的资源", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "资源ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除资源成功", "data": { "result": true } }, "failure": { "code": "4000", "message": "删除资源失败", "data": null } } } ] }, { "module": "客户管理", "moduleKey": "customer", "apiCount": 5, "apis": [ { "title": "获取客户列表", "method": "GET", "path": "/api/customers", "description": "分页获取客户列表", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "客户名称关键词" }, { "name": "status", "type": "number", "required": false, "description": "状态过滤" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "code": "CUS0001", "name": "示例客户", "contactName": "李四", "contactPhone": "021-88888888", "status": 1 } ], "total": 100, "pageNum": 1, "pageSize": 10 } } } }, { "title": "获取客户详情", "method": "GET", "path": "/api/customers/{id}", "description": "根据客户ID获取客户详细信息", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "客户ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "CUS0001", "name": "示例客户", "contactName": "李四", "contactPhone": "021-88888888", "status": 1 } }, "failure": { "code": "4040", "message": "客户不存在", "data": null } } }, { "title": "创建客户", "method": "POST", "path": "/api/customers", "description": "创建新的客户", "requestParams": { "body": { "name": "string｜必填，客户名称", "contactName": "string｜可选，联系人姓名", "contactPhone": "string｜可选，联系人电话", "status": "number｜可选，状态：1-合作中，0-已终止" } }, "responseExample": { "success": { "code": "0000", "message": "创建客户成功", "data": { "id": 1, "code": "CUS0001", "name": "示例客户", "contactName": "李四", "contactPhone": "021-88888888", "status": 1 } }, "failure": { "code": "4000", "message": "创建客户失败", "data": null } } }, { "title": "更新客户", "method": "PUT", "path": "/api/customers/{id}", "description": "更新指定客户的信息", "requestParams": { "body": { "name": "string｜必填，客户名称", "contactName": "string｜可选，联系人姓名", "contactPhone": "string｜可选，联系人电话", "status": "number｜可选，状态：1-合作中，0-已终止" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "客户ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新客户成功", "data": { "id": 1, "code": "CUS0001", "name": "示例客户", "contactName": "李四", "contactPhone": "021-88888888", "status": 1 } }, "failure": { "code": "4000", "message": "更新客户失败", "data": null } } }, { "title": "删除客户", "method": "DELETE", "path": "/api/customers/{id}", "description": "删除指定的客户", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "客户ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除客户成功", "data": { "result": true } }, "failure": { "code": "4000", "message": "删除客户失败", "data": null } } } ] }, { "module": "会员管理", "moduleKey": "member", "apiCount": 7, "apis": [ { "title": "获取有效会员列表", "method": "GET", "path": "/api/members/valid-list", "description": "获取所有状态为有效（status=1）的会员套餐列表，用于下拉选择。无需分页，返回简化的字段信息。", "requestParams": {}, "responseExample": { "success": { "code": "0000", "message": "操作成功", "data": [ { "id": "xxx", "_id": "xxx", "code": "MEM0001", "name": "会员套餐1", "description": "套餐描述" }, { "id": "yyy", "_id": "yyy", "code": "MEM0002", "name": "会员套餐2", "description": "套餐描述" } ], "timestamp": "2025-01-21T10:00:00.000Z" }, "failure": { "code": "4000", "message": "获取失败", "data": null } }, "notes": [ "该接口仅返回状态为有效（status=1）的会员套餐", "返回结果按创建时间升序排序", "需要 members 的 read 权限", "适用于下拉选择等场景，无需分页" ] }, { "title": "获取会员列表", "method": "GET", "path": "/api/members", "description": "分页获取会员套餐列表", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "套餐名称关键词" }, { "name": "memberTypeId", "type": "string", "required": false, "description": "会员类型ID（会员类型管理记录的_id）" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "code": "MEM0001", "name": "会员套餐名称", "memberTypeId": "xxx", "price": "99.99", "validityDays": 30, "description": "套餐描述", "status": 1 } ], "total": 100, "pageNum": 1, "pageSize": 10 } } } }, { "title": "获取会员详情", "method": "GET", "path": "/api/members/{id}", "description": "根据会员套餐ID获取会员套餐详细信息", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "会员套餐ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "MEM0001", "name": "会员套餐名称", "memberTypeId": "xxx", "price": "99.99", "validityDays": 30, "description": "套餐描述", "status": 1 } }, "failure": { "code": "4040", "message": "会员套餐不存在", "data": null } } }, { "title": "创建会员", "method": "POST", "path": "/api/members", "description": "创建新的会员套餐", "requestParams": { "body": { "name": "string｜必填，套餐名称", "memberTypeId": "string｜可选，会员类型ID（会员类型管理记录的_id），如果提供会校验会员类型是否存在", "price": "string｜可选，价格（两位小数，如：99.99）", "validityDays": "number｜可选，有效期天数（最小值为1）", "description": "string｜可选，套餐描述", "status": "number｜可选，状态：1-有效，0-无效，默认0" } }, "responseExample": { "success": { "code": "0000", "message": "创建会员成功", "data": { "id": 1, "code": "MEM0001", "name": "会员套餐名称", "memberTypeId": "xxx", "price": "99.99", "validityDays": 30, "description": "套餐描述", "status": 0 } }, "failure": { "code": "4000", "message": "关联的会员类型不存在", "data": null } }, "notes": [ "如果提供了memberTypeId，会校验会员类型是否存在，不存在返回错误：关联的会员类型不存在" ] }, { "title": "更新会员", "method": "PUT", "path": "/api/members/{id}", "description": "更新指定会员套餐的信息", "requestParams": { "body": { "name": "string｜必填，套餐名称", "memberTypeId": "string｜可选，会员类型ID（会员类型管理记录的_id），如果提供会校验会员类型是否存在", "price": "string｜可选，价格（两位小数，如：99.99）", "validityDays": "number｜可选，有效期天数（最小值为1）", "description": "string｜可选，套餐描述", "status": "number｜可选，状态：1-有效，0-无效，默认0" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "会员套餐ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新会员成功", "data": { "id": 1, "code": "MEM0001", "name": "会员套餐名称", "memberTypeId": "xxx", "price": "99.99", "validityDays": 30, "description": "套餐描述", "status": 1 } }, "failure": { "code": "4000", "message": "关联的会员类型不存在", "data": null } }, "notes": [ "如果提供了memberTypeId，会校验会员类型是否存在，不存在返回错误：关联的会员类型不存在", "有效状态（status=1）的会员套餐不允许修改，会返回错误：有效状态的会员套餐不允许修改" ] }, { "title": "删除会员", "method": "DELETE", "path": "/api/members/{id}", "description": "删除指定的会员套餐", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "会员套餐ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除会员成功", "data": { "result": true } }, "failure": { "code": "4000", "message": "删除会员失败", "data": null } }, "notes": [ "有效状态（status=1）的会员套餐不允许删除，会返回错误：有效状态的会员套餐不允许删除" ] }, { "title": "切换会员套餐状态", "method": "PUT", "path": "/api/members/{id}/status", "description": "切换会员套餐的启用/禁用状态", "requestParams": { "body": { "status": "number｜必填，状态：1-有效，0-无效" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "会员套餐ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "状态更新成功", "data": { "id": 1, "code": "MEM0001", "name": "会员套餐名称", "memberTypeId": "xxx", "price": "99.99", "validityDays": 30, "description": "套餐描述", "status": 1, "updateTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4040", "message": "会员套餐不存在", "data": null } }, "notes": [ "该接口用于切换会员套餐的启用/禁用状态", "只有通过状态切换接口才能修改有效状态的会员套餐" ] } ] }, { "module": "会员类型管理", "moduleKey": "memberType", "apiCount": 6, "apis": [ { "title": "获取有效会员类型列表", "method": "GET", "path": "/api/members/types/valid-list", "description": "获取所有状态为有效（status=1）的会员类型列表，用于下拉选择。无需分页，返回简化的字段信息。", "requestParams": {}, "responseExample": { "success": { "code": "0000", "message": "操作成功", "data": [ { "id": "xxx", "_id": "xxx", "code": "VIP", "name": "VIP会员", "description": "VIP会员类型" }, { "id": "yyy", "_id": "yyy", "code": "GOLD", "name": "黄金会员", "description": "黄金会员类型" } ], "timestamp": "2025-01-21T10:00:00.000Z" }, "failure": { "code": "4000", "message": "获取失败", "data": null } }, "notes": [ "该接口仅返回状态为有效（status=1）的会员类型", "返回结果按创建时间升序排序", "需要 memberTypes 的 read 权限", "适用于下拉选择等场景，无需分页" ] }, { "title": "获取会员类型列表", "method": "GET", "path": "/api/members/types", "description": "分页获取会员类型列表，支持按名称、编码、状态筛选", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "会员类型名称关键词" }, { "name": "code", "type": "string", "required": false, "description": "会员类型编码关键词" }, { "name": "status", "type": "number", "required": false, "description": "状态过滤：1-有效，0-无效" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "code": "VIP", "name": "VIP会员", "description": "VIP会员类型", "status": 1, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 100, "pageNum": 1, "pageSize": 10, "totalPages": 10 } } } }, { "title": "创建会员类型", "method": "POST", "path": "/api/members/types", "description": "创建新的会员类型", "requestParams": { "body": { "name": "string｜必填，会员类型名称", "code": "string｜必填，会员类型编码", "status": "number｜可选，状态：1-有效，0-无效，默认1", "description": "string｜可选，描述信息" } }, "responseExample": { "success": { "code": "0000", "message": "创建成功", "data": { "id": 1, "code": "VIP", "name": "VIP会员", "description": "VIP会员类型", "status": 1, "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "会员类型编码已存在", "data": null } } }, { "title": "更新会员类型", "method": "PUT", "path": "/api/members/types/{typeId}", "description": "更新指定会员类型的信息", "requestParams": { "body": { "name": "string｜可选，会员类型名称", "code": "string｜可选，会员类型编码", "status": "number｜可选，状态：1-有效，0-无效", "description": "string｜可选，描述信息" }, "path": [ { "name": "typeId", "type": "string", "required": true, "description": "会员类型ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新成功", "data": { "id": 1, "code": "VIP", "name": "VIP会员", "description": "VIP会员类型", "status": 1, "updateTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "会员类型编码已存在", "data": null } } }, { "title": "删除会员类型", "method": "DELETE", "path": "/api/members/types/{typeId}", "description": "删除指定的会员类型", "requestParams": { "path": [ { "name": "typeId", "type": "string", "required": true, "description": "会员类型ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除成功", "data": null }, "failure": { "code": "4000", "message": "会员类型仍与会员功能关联，请先解除关联", "data": null } } }, { "title": "切换会员类型状态", "method": "PUT", "path": "/api/members/types/{typeId}/status", "description": "切换会员类型的启用/禁用状态", "requestParams": { "body": { "status": "number｜必填，状态：1-有效，0-无效" }, "path": [ { "name": "typeId", "type": "string", "required": true, "description": "会员类型ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "状态更新成功", "data": { "id": 1, "code": "VIP", "name": "VIP会员", "status": 1, "updateTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4040", "message": "会员类型不存在", "data": null } } } ] }, { "module": "无状态会员管理", "moduleKey": "statelessMember", "apiCount": 6, "apis": [ { "title": "获取无状态会员列表", "method": "GET", "path": "/api/stateless-members", "description": "分页获取无状态会员列表", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "会员名称关键词" }, { "name": "code", "type": "string", "required": false, "description": "会员编码" }, { "name": "memberTypeId", "type": "string", "required": false, "description": "按会员类型ID筛选（会员类型管理记录的_id）" }, { "name": "status", "type": "number", "required": false, "description": "状态过滤" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "code": "SM0001", "name": "开放平台会员", "secretKey": "sk-xxx", "memberTypeId": "xxx", "status": 1 } ], "total": 100, "pageNum": 1, "pageSize": 10 } } } }, { "title": "获取无状态会员详情", "method": "GET", "path": "/api/stateless-members/{id}", "description": "根据无状态会员ID获取详细信息", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "无状态会员ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "SM0001", "name": "开放平台会员", "secretKey": "sk-xxx", "memberTypeId": "xxx", "status": 1 } }, "failure": { "code": "4040", "message": "无状态会员不存在", "data": null } } }, { "title": "创建无状态会员", "method": "POST", "path": "/api/stateless-members", "description": "创建新的无状态会员", "requestParams": { "body": { "name": "string｜必填，会员名称", "memberTypeId": "string｜可选，会员类型ID（会员类型管理记录的_id），如果提供会校验会员类型是否存在", "effectiveDate": "string｜必填，生效日期", "validityDays": "number｜必填，有效期天数（最小7天）", "firstEffectiveDate": "string｜可选，首次生效日期", "status": "number｜可选，状态：1-有效，0-无效，默认0" } }, "responseExample": { "success": { "code": "0000", "message": "创建无状态会员成功", "data": { "id": 1, "code": "SM0001", "name": "开放平台会员", "secretKey": "sk-xxx", "memberTypeId": "xxx", "status": 1 } }, "failure": { "code": "4000", "message": "关联的会员类型不存在", "data": null } }, "notes": [ "secretKey会自动生成，无需手动提供", "如果提供了memberTypeId，会校验会员类型是否存在，不存在返回错误：关联的会员类型不存在" ] }, { "title": "更新无状态会员", "method": "PUT", "path": "/api/stateless-members/{id}", "description": "更新指定无状态会员的信息", "requestParams": { "body": { "name": "string｜可选，会员名称", "memberTypeId": "string｜可选，会员类型ID（会员类型管理记录的_id），如果提供会校验会员类型是否存在", "effectiveDate": "string｜可选，生效日期", "validityDays": "number｜可选，有效期天数（最小7天）", "firstEffectiveDate": "string｜可选，首次生效日期", "status": "number｜可选，状态：1-有效，0-无效" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "无状态会员ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新无状态会员成功", "data": { "id": 1, "code": "SM0001", "name": "开放平台会员", "secretKey": "sk-xxx", "memberTypeId": "xxx", "status": 1 } }, "failure": { "code": "4000", "message": "关联的会员类型不存在", "data": null } }, "notes": [ "如果提供了memberTypeId，会校验会员类型是否存在，不存在返回错误：关联的会员类型不存在", "有效状态（status=1）的无状态会员不允许修改，会返回错误：有效状态的无状态会员不允许修改" ] }, { "title": "删除无状态会员", "method": "DELETE", "path": "/api/stateless-members/{id}", "description": "删除指定的无状态会员", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "无状态会员ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除无状态会员成功", "data": { "result": true } }, "failure": { "code": "4000", "message": "删除无状态会员失败", "data": null } }, "notes": [ "有效状态（status=1）的无状态会员不允许删除，会返回错误：有效状态的无状态会员不允许删除" ] }, { "title": "切换无状态会员状态", "method": "PUT", "path": "/api/stateless-members/{id}/status", "description": "切换无状态会员的启用/禁用状态", "requestParams": { "body": { "status": "number｜必填，状态：1-有效，0-无效" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "无状态会员ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "状态更新成功", "data": { "id": 1, "code": "SM0001", "name": "开放平台会员", "secretKey": "sk-xxx", "memberTypeId": "xxx", "effectiveDate": "2025-01-01", "validityDays": 365, "firstEffectiveDate": "2025-01-01", "status": 1, "updateTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4040", "message": "无状态会员不存在", "data": null } }, "notes": [ "该接口用于切换无状态会员的启用/禁用状态", "只有通过状态切换接口才能修改有效状态的无状态会员" ] } ] }, { "module": "会员用户管理", "moduleKey": "memberUser", "apiCount": 5, "apis": [ { "title": "获取会员用户列表", "method": "GET", "path": "/api/member-users", "description": "分页获取会员用户列表", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "userId", "type": "string", "required": false, "description": "按客户端用户筛选" }, { "name": "memberId", "type": "string", "required": false, "description": "按会员ID筛选（会员管理记录的_id）" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "code": "MU0001", "userId": "CU0001", "memberId": "xxx", "status": 1 } ], "total": 100, "pageNum": 1, "pageSize": 10 } } } }, { "title": "获取会员用户详情", "method": "GET", "path": "/api/member-users/{id}", "description": "根据会员用户ID获取详细信息", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "会员用户ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "MU0001", "userId": "CU0001", "memberId": "xxx", "status": 1 } }, "failure": { "code": "4040", "message": "会员用户不存在", "data": null } } }, { "title": "创建会员用户", "method": "POST", "path": "/api/member-users", "description": "创建新的会员用户", "requestParams": { "body": { "userId": "string｜可选，绑定的客户端用户ID", "memberId": "string｜可选，会员ID（会员管理记录的_id），如果提供会校验会员是否存在且有效", "status": "number｜可选，状态：1-有效，0-无效" } }, "responseExample": { "success": { "code": "0000", "message": "创建会员用户成功", "data": { "id": 1, "code": "MU0001", "userId": "CU0001", "memberId": "xxx", "status": 1 } }, "failure": { "code": "4000", "message": "关联的会员不存在", "data": null } }, "notes": [ "如果提供了memberId，会校验会员是否存在且有效（status=1），不存在或已停用返回错误：关联的会员不存在或关联的会员已停用" ] }, { "title": "更新会员用户", "method": "PUT", "path": "/api/member-users/{id}", "description": "更新指定会员用户的信息", "requestParams": { "body": { "userId": "string｜可选，绑定的客户端用户ID", "memberId": "string｜可选，会员ID（会员管理记录的_id），如果提供会校验会员是否存在且有效", "status": "number｜可选，状态：1-有效，0-无效" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "会员用户ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新会员用户成功", "data": { "id": 1, "code": "MU0001", "userId": "CU0001", "memberId": "xxx", "status": 1 } }, "failure": { "code": "4000", "message": "关联的会员不存在", "data": null } }, "notes": [ "如果提供了memberId，会校验会员是否存在且有效（status=1），不存在或已停用返回错误：关联的会员不存在或关联的会员已停用" ] }, { "title": "删除会员用户", "method": "DELETE", "path": "/api/member-users/{id}", "description": "删除指定的会员用户", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "会员用户ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除会员用户成功", "data": { "result": true } }, "failure": { "code": "4000", "message": "删除会员用户失败", "data": null } } } ] }, { "module": "会员功能管理", "moduleKey": "memberFunction", "apiCount": 6, "apis": [ { "title": "获取会员功能列表", "method": "GET", "path": "/api/members/functions", "description": "分页获取会员功能配置列表，支持按会员类型、系统、状态筛选", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "memberTypeId", "type": "string", "required": false, "description": "按会员类型ID筛选" }, { "name": "systemId", "type": "string", "required": false, "description": "按系统ID筛选" }, { "name": "status", "type": "number", "required": false, "description": "状态：1-启用，0-禁用" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "code": "MF0001", "memberTypeId": "xxx", "memberType": "VIP会员", "systemId": "yyy", "systemName": "权限管理系统", "status": 1, "description": "会员功能配置示例" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } } }, { "title": "获取会员功能详情", "method": "GET", "path": "/api/members/functions/{id}", "description": "根据ID获取会员功能配置详情", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "会员功能ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "MF0001", "memberTypeId": "xxx", "memberType": "VIP会员", "systemId": "yyy", "systemName": "权限管理系统", "status": 1 } }, "failure": { "code": "4040", "message": "会员功能不存在", "data": null } } }, { "title": "创建会员功能", "method": "POST", "path": "/api/members/functions", "description": "为会员类型配置系统级功能入口（同会员类型+系统唯一）", "requestParams": { "body": { "memberTypeId": "string｜必填，会员类型ID", "systemId": "string｜必填，系统ID", "status": "number｜可选，状态：1-启用，0-禁用，默认1", "description": "string｜可选，描述" } }, "responseExample": { "success": { "code": "0000", "message": "创建成功", "data": { "id": 1, "code": "MF0001", "memberTypeId": "xxx", "memberType": "VIP会员", "systemId": "yyy", "systemName": "权限管理系统", "status": 1 } }, "failure": { "code": "4090", "message": "该会员类型在当前系统下已配置功能", "data": null } } }, { "title": "更新会员功能", "method": "PUT", "path": "/api/members/functions/{id}", "description": "更新会员功能配置（可更新会员类型、系统、状态、描述）", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "会员功能ID" } ], "body": { "memberTypeId": "string｜可选，会员类型ID", "systemId": "string｜可选，系统ID", "status": "number｜可选，状态：1-启用，0-禁用", "description": "string｜可选，描述" } }, "responseExample": { "success": { "code": "0000", "message": "更新成功", "data": { "id": 1, "code": "MF0001", "memberTypeId": "xxx", "systemId": "yyy", "status": 1 } } } }, { "title": "删除会员功能", "method": "DELETE", "path": "/api/members/functions/{id}", "description": "删除会员功能配置，同时会清理其关联的功能模块关系", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "会员功能ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除成功", "data": { "result": true } } } }, { "title": "切换会员功能状态", "method": "PUT", "path": "/api/members/functions/{id}/status", "description": "切换会员功能配置启用/禁用状态", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "会员功能ID" } ], "body": { "status": "number｜必填，状态：1-启用，0-禁用" } }, "responseExample": { "success": { "code": "0000", "message": "状态更新成功", "data": { "id": 1, "code": "MF0001", "status": 1 } } } } ] }, { "module": "会员功能限制配置", "moduleKey": "memberFunctionLimit", "apiCount": 5, "apis": [ { "title": "获取会员功能限制列表", "method": "GET", "path": "/api/members/function-limits", "description": "分页获取会员功能限制配置，支持按会员类型、系统、模块、状态筛选", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "memberTypeId", "type": "string", "required": false, "description": "会员类型ID" }, { "name": "systemId", "type": "string", "required": false, "description": "系统ID" }, { "name": "moduleId", "type": "string", "required": false, "description": "模块ID" }, { "name": "status", "type": "number", "required": false, "description": "状态：1-启用，0-禁用" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "code": "MFL0001", "memberTypeId": "xxx", "memberTypeName": "VIP会员", "systemId": "yyy", "systemName": "权限管理系统", "moduleId": "zzz", "moduleName": "订单管理", "limitValue": 100, "status": 1 } ], "total": 1, "pageNum": 1, "pageSize": 10 } } } }, { "title": "创建会员功能限制", "method": "POST", "path": "/api/members/function-limits", "description": "创建会员类型在系统模块上的额度限制（memberTypeId+systemId+moduleId唯一）", "requestParams": { "body": { "memberTypeId": "string｜必填，会员类型ID", "systemId": "string｜必填，系统ID", "moduleId": "string｜必填，模块ID", "limitValue": "number｜必填，限制值（>=0）", "status": "number｜可选，状态：1-启用，0-禁用，默认1", "description": "string｜可选，描述" } }, "responseExample": { "success": { "code": "0000", "message": "创建成功", "data": { "id": 1, "code": "MFL0001", "memberTypeId": "xxx", "systemId": "yyy", "moduleId": "zzz", "limitValue": 100, "status": 1 } } } }, { "title": "更新会员功能限制", "method": "PUT", "path": "/api/members/function-limits/{limitId}", "description": "更新指定限制配置", "requestParams": { "path": [ { "name": "limitId", "type": "string", "required": true, "description": "限制配置ID" } ], "body": { "memberTypeId": "string｜可选，会员类型ID", "systemId": "string｜可选，系统ID", "moduleId": "string｜可选，模块ID", "limitValue": "number｜可选，限制值（>=0）", "status": "number｜可选，状态：1-启用，0-禁用", "description": "string｜可选，描述" } }, "responseExample": { "success": { "code": "0000", "message": "更新成功", "data": { "id": 1, "code": "MFL0001", "limitValue": 200, "status": 1 } } } }, { "title": "删除会员功能限制", "method": "DELETE", "path": "/api/members/function-limits/{limitId}", "description": "删除指定限制配置", "requestParams": { "path": [ { "name": "limitId", "type": "string", "required": true, "description": "限制配置ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除成功", "data": { "result": true } } } }, { "title": "切换会员功能限制状态", "method": "PUT", "path": "/api/members/function-limits/{limitId}/status", "description": "切换限制配置启用/禁用状态", "requestParams": { "path": [ { "name": "limitId", "type": "string", "required": true, "description": "限制配置ID" } ], "body": { "status": "number｜必填，状态：1-启用，0-禁用" } }, "responseExample": { "success": { "code": "0000", "message": "状态更新成功", "data": { "id": 1, "code": "MFL0001", "status": 1 } } } } ] }, { "module": "白名单管理", "moduleKey": "whitelist", "apiCount": 5, "apis": [ { "title": "获取白名单列表", "method": "GET", "path": "/api/whitelists", "description": "分页获取白名单列表", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "userId", "type": "string", "required": false, "description": "按用户筛选" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "userId": "USER0001", "reason": "业务合作", "createTime": "2025-01-01T10:00:00.000Z" } ], "total": 100, "pageNum": 1, "pageSize": 10 } } } }, { "title": "获取白名单详情", "method": "GET", "path": "/api/whitelists/{id}", "description": "根据白名单ID获取详细信息", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "白名单ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "userId": "USER0001", "reason": "业务合作", "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4040", "message": "白名单不存在", "data": null } } }, { "title": "创建白名单", "method": "POST", "path": "/api/whitelists", "description": "创建新的白名单", "requestParams": { "body": { "userId": "string｜必填，用户ID", "reason": "string｜可选，加入白名单原因" } }, "responseExample": { "success": { "code": "0000", "message": "创建白名单成功", "data": { "id": 1, "userId": "USER0001", "reason": "业务合作", "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "创建白名单失败", "data": null } } }, { "title": "更新白名单", "method": "PUT", "path": "/api/whitelists/{id}", "description": "更新指定白名单的信息", "requestParams": { "body": { "userId": "string｜必填，用户ID", "reason": "string｜可选，加入白名单原因" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "白名单ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新白名单成功", "data": { "id": 1, "userId": "USER0001", "reason": "业务合作", "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "更新白名单失败", "data": null } } }, { "title": "删除白名单", "method": "DELETE", "path": "/api/whitelists/{id}", "description": "删除指定的白名单", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "白名单ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除白名单成功", "data": { "result": true } }, "failure": { "code": "4000", "message": "删除白名单失败", "data": null } } } ] }, { "module": "黑名单管理", "moduleKey": "blacklist", "apiCount": 5, "apis": [ { "title": "获取黑名单列表", "method": "GET", "path": "/api/blacklists", "description": "分页获取黑名单列表", "requestParams": { "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "userId", "type": "string", "required": false, "description": "按用户筛选" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "userId": "USER0002", "reason": "恶意操作", "createTime": "2025-01-01T10:00:00.000Z" } ], "total": 100, "pageNum": 1, "pageSize": 10 } } } }, { "title": "获取黑名单详情", "method": "GET", "path": "/api/blacklists/{id}", "description": "根据黑名单ID获取详细信息", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "黑名单ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "userId": "USER0002", "reason": "恶意操作", "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4040", "message": "黑名单不存在", "data": null } } }, { "title": "创建黑名单", "method": "POST", "path": "/api/blacklists", "description": "创建新的黑名单", "requestParams": { "body": { "userId": "string｜必填，用户ID", "reason": "string｜可选，加入黑名单原因" } }, "responseExample": { "success": { "code": "0000", "message": "创建黑名单成功", "data": { "id": 1, "userId": "USER0002", "reason": "恶意操作", "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "创建黑名单失败", "data": null } } }, { "title": "更新黑名单", "method": "PUT", "path": "/api/blacklists/{id}", "description": "更新指定黑名单的信息", "requestParams": { "body": { "userId": "string｜必填，用户ID", "reason": "string｜可选，加入黑名单原因" }, "path": [ { "name": "id", "type": "string", "required": true, "description": "黑名单ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "更新黑名单成功", "data": { "id": 1, "userId": "USER0002", "reason": "恶意操作", "createTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4000", "message": "更新黑名单失败", "data": null } } }, { "title": "删除黑名单", "method": "DELETE", "path": "/api/blacklists/{id}", "description": "删除指定的黑名单", "requestParams": { "path": [ { "name": "id", "type": "string", "required": true, "description": "黑名单ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "删除黑名单成功", "data": { "result": true } }, "failure": { "code": "4000", "message": "删除黑名单失败", "data": null } } } ] }, { "module": "安全系统管理", "moduleKey": "securitySystem", "apiCount": 2, "apis": [ { "title": "查询所有有效系统", "method": "GET", "path": "/api/security/systems/active", "description": "查询所有有效的系统配置列表，用于其他业务通过选择列表选择目标系统。返回所有 status = 1 的系统，不需要分页", "requestParams": {}, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": [ { "id": 1, "code": "AUTH", "name": "权限管理系统", "status": 1, "description": "权限管理系统描述", "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" }, { "id": 2, "code": "ORDER", "name": "订单管理系统", "status": 1, "description": "订单管理系统描述", "createTime": "2025-01-01T11:00:00.000Z", "updateTime": "2025-01-01T11:00:00.000Z" } ] } }, "notes": [ "仅返回 status = 1 的有效系统", "按创建时间倒序排列", "不需要分页，返回完整列表" ] }, { "title": "查询某个系统下的有效模块", "method": "GET", "path": "/api/security/systems/{systemId}/modules/active", "description": "查询指定系统下所有有效的模块列表，用于其他业务通过选择列表选择目标模块。返回所有 status = 1 的模块，不需要分页", "requestParams": { "path": [ { "name": "systemId", "type": "string", "required": true, "description": "系统ID" } ] }, "responseExample": { "success": { "code": "0000", "message": "获取成功", "data": [ { "id": 1, "code": "AUTH_USER", "name": "用户管理模块", "systemId": "系统ID", "systemName": "权限管理系统", "status": 1, "description": "用户管理模块描述", "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" }, { "id": 2, "code": "AUTH_ROLE", "name": "角色管理模块", "systemId": "系统ID", "systemName": "权限管理系统", "status": 1, "description": "角色管理模块描述", "createTime": "2025-01-01T11:00:00.000Z", "updateTime": "2025-01-01T11:00:00.000Z" } ] }, "failure": { "code": "4040", "message": "系统不存在", "data": null } }, "notes": [ "仅返回指定系统下 status = 1 的有效模块", "按创建时间倒序排列", "不需要分页，返回完整列表", "如果系统不存在，返回404错误" ] } ] }, { "module": "OpenAPI 接口", "moduleKey": "openapi", "apiCount": 66, "apis": [ { "title": "有状态会员有效性校验（场景A）", "method": "POST", "path": "/openapi/memberships/valid-check", "description": "场景A：校验已登录用户的会员是否有效（未过期），不校验系统支持。适用于第三方已持有用户登录令牌，只需确认该用户是否有效会员的场景。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "用户登录令牌，格式 Bearer TOKEN（通过 /memberships/login 获取）" }, { "name": "X-Site", "type": "string", "required": true, "description": "站点标识" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（用于路由到正确数据库）" } ] }, "responseExamples": { "校验通过": { "code": "0000", "message": "会员有效", "data": { "valid": true, "remainingDays": 20, "memberType": { "id": "xxx", "name": "黄金会员", "code": "H001" }, "memberUser": { "id": "mu001", "code": "MU000001", "effectiveDate": "2026-03-01", "validityDays": 30 }, "user": { "id": "u001", "code": "CU000001", "phone": "138****8888", "name": "张三" } } }, "未找到有效会员记录": { "code": "1503", "message": "未找到有效的会员记录", "data": null }, "令牌无效": { "code": "1002", "message": "访问令牌无效或已过期", "data": null } }, "notes": [ "系统自动取该用户最新一条未过期的 memberUser 记录", "场景B（验系统支持）请使用 /memberships/check", "场景C（验功能模块）请使用 /memberships/functionCheck", "场景D（验功能限额）请使用 /memberships/limitCheck" ] }, { "title": "有状态会员系统支持校验（场景B）", "method": "POST", "path": "/openapi/memberships/check", "description": "场景B：校验已登录用户的会员有效性，并校验该用户的会员类型是否已配置支持指定系统。适用于系统级访问控制，如黄金会员才能访问系统B。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "用户登录令牌，格式 Bearer TOKEN" }, { "name": "X-Site", "type": "string", "required": true, "description": "站点标识" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码，同时作为校验目标（会员类型是否支持该系统）" } ] }, "responseExamples": { "校验通过": { "code": "0000", "message": "校验通过", "data": { "valid": true, "remainingDays": 20, "memberType": { "id": "xxx", "name": "钻石会员", "code": "D001" }, "memberUser": { "id": "mu001", "code": "MU000001", "effectiveDate": "2026-03-01", "validityDays": 30 }, "user": { "id": "u001", "code": "CU000001", "phone": "138****8888", "name": "张三" }, "system": { "code": "system-b", "name": "系统B" } } }, "会员类型不支持该系统": { "code": "1007", "message": "会员类型未授权当前系统", "data": null }, "未找到有效会员记录": { "code": "1503", "message": "未找到有效的会员记录", "data": null } }, "notes": [ "需在管理后台「会员功能管理」中为该会员类型配置支持该系统，否则会返回1007", "系统校验基于 memberFunctions 表（memberTypeId + systemId + status=1）" ] }, { "title": "有状态会员功能模块校验（场景C）", "method": "POST", "path": "/openapi/memberships/functionCheck", "description": "场景C：在场景B基础上，进一步校验该用户的会员类型在指定系统下是否开通了特定功能模块。适用于菜单/功能级别的精细控制。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "用户登录令牌，格式 Bearer TOKEN" }, { "name": "X-Site", "type": "string", "required": true, "description": "站点标识" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码" }, { "name": "X-Function", "type": "string", "required": true, "description": "功能模块代码（moduleCode），如 VIDEO_DOWNLOAD" } ] }, "responseExamples": { "校验通过": { "code": "0000", "message": "校验通过", "data": { "valid": true, "remainingDays": 20, "memberType": { "id": "xxx", "name": "钻石会员", "code": "D001" }, "memberUser": { "id": "mu001", "code": "MU000001", "effectiveDate": "2026-03-01", "validityDays": 30 }, "user": { "id": "u001", "code": "CU000001", "phone": "138****8888", "name": "张三" }, "system": { "code": "system-b", "name": "系统B" }, "function": { "code": "VIDEO_DOWNLOAD", "name": "视频下载" } } }, "会员不支持该功能": { "code": "1508", "message": "当前会员不支持当前功能", "data": null }, "会员类型不支持该系统": { "code": "1007", "message": "会员类型未授权当前系统", "data": null } }, "notes": [ "需在管理后台「会员功能模块」中为该会员类型的系统功能配置对应模块", "X-Function 传入 moduleCode（Custom类型）或 securityModule.code（Resource类型）" ] }, { "title": "有状态会员限额校验（场景D）", "method": "POST", "path": "/openapi/memberships/limitCheck", "description": "场景D：在场景C基础上，进一步校验当前功能模块的使用量是否已达配置上限。适用于有存储量/次数上限的业务，如最多保存10条数据。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "用户登录令牌，格式 Bearer TOKEN" }, { "name": "X-Site", "type": "string", "required": true, "description": "站点标识" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码" }, { "name": "X-Function", "type": "string", "required": true, "description": "功能模块代码" } ], "body": { "currentCount": "number｜必填，当前已使用次数/数量（由第三方系统维护）" } }, "responseExamples": { "校验通过（有限额）": { "code": "0000", "message": "校验通过", "data": { "valid": true, "remainingDays": 20, "memberType": { "id": "xxx", "name": "钻石会员", "code": "D001" }, "memberUser": { "id": "mu001", "code": "MU000001", "effectiveDate": "2026-03-01", "validityDays": 30 }, "user": { "id": "u001", "code": "CU000001", "phone": "138****8888", "name": "张三" }, "system": { "code": "system-b", "name": "系统B" }, "function": { "code": "DATA_SAVE", "name": "数据保存" }, "limit": { "value": 10, "current": 8, "remaining": 2 } } }, "校验通过（无限额）": { "code": "0000", "message": "校验通过", "data": { "valid": true, "limit": null } }, "已达使用上限": { "code": "1010", "message": "当前功能使用已达上限（10）", "data": { "limitValue": 10, "currentCount": 10 } } }, "notes": [ "limit 为 null 表示未配置限额，不限次数", "currentCount 由第三方系统传入，本系统不持久化使用记录", "限额配置在管理后台「会员功能限制」中设置（memberFunctionLimits 表）" ] }, { "title": "无状态会员资源校验（场景A）", "method": "POST", "path": "/openapi/stateless-members/resources/valid-check", "description": "返回与 /openapi/permissions/check 一致的资源结构，并叠加无状态会员有效性约束（仅校验会员有效）。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "账号登录令牌，格式 Bearer TOKEN" }, { "name": "X-Member-Key", "type": "string", "required": true, "description": "会员密钥令牌" }, { "name": "X-Site", "type": "string", "required": true, "description": "站点标识" } ] }, "responseExample": { "success": { "code": "0000", "message": "校验通过", "data": { "user": { "id": "u001", "code": "CU000001", "username": "张三", "type": "clientUser" }, "resources": [], "resourcesByType": {}, "resourceUrls": [] } } }, "notes": [ "响应结构与 /openapi/permissions/check 一致", "当会员约束不满足时，返回空资源（resources=[]）" ] }, { "title": "无状态会员资源校验（场景B）", "method": "POST", "path": "/openapi/stateless-members/resources/check", "description": "返回与 /openapi/permissions/check 一致的资源结构，并叠加无状态会员有效性+系统支持约束。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "账号登录令牌，格式 Bearer TOKEN" }, { "name": "X-Member-Key", "type": "string", "required": true, "description": "会员密钥令牌" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码" }, { "name": "X-Site", "type": "string", "required": true, "description": "站点标识" } ] }, "responseExample": { "success": { "code": "0000", "message": "校验通过", "data": { "system": { "code": "AUTH_MANAGEMENT", "name": "权限管理系统" }, "resources": [], "resourcesByType": {}, "resourceUrls": [] } } }, "notes": [ "系统级校验与 /openapi/stateless-members/check 参数要求一致", "会员不支持系统时，资源返回为空" ] }, { "title": "无状态会员资源校验（场景C）", "method": "POST", "path": "/openapi/stateless-members/resources/functionCheck", "description": "返回与 /openapi/permissions/check 一致的资源结构，并叠加无状态会员有效性+系统约束。系统会自动解析该会员在当前系统下已授权的模块，并返回对应模块资源。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "账号登录令牌，格式 Bearer TOKEN" }, { "name": "X-Member-Key", "type": "string", "required": true, "description": "会员密钥令牌" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码" }, { "name": "X-Site", "type": "string", "required": true, "description": "站点标识" } ] }, "responseExample": { "success": { "code": "0000", "message": "校验通过", "data": { "resources": [], "resourcesByType": {}, "resourceUrls": [] } } } }, { "title": "无状态会员资源校验（场景D）", "method": "POST", "path": "/openapi/stateless-members/resources/limitCheck", "description": "返回与 /openapi/permissions/check 一致的资源结构，并叠加无状态会员有效性+系统+限额约束。系统会自动按会员在当前系统下已授权模块过滤资源，并对这些模块应用限额筛选。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "账号登录令牌，格式 Bearer TOKEN" }, { "name": "X-Member-Key", "type": "string", "required": true, "description": "会员密钥令牌" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码" }, { "name": "X-Site", "type": "string", "required": true, "description": "站点标识" } ], "body": { "currentCount": "number｜必填，当前已使用次数/数量" } }, "responseExample": { "success": { "code": "0000", "message": "校验通过", "data": { "resources": [], "resourcesByType": {}, "resourceUrls": [] } } } }, { "title": "有状态会员资源校验（场景A）", "method": "POST", "path": "/openapi/memberships/resources/valid-check", "description": "返回与 /openapi/permissions/check 一致的资源结构，并叠加有状态会员有效性约束。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "用户登录令牌，格式 Bearer TOKEN" }, { "name": "X-Site", "type": "string", "required": true, "description": "站点标识" } ] }, "responseExample": { "success": { "code": "0000", "message": "校验通过", "data": { "resources": [], "resourcesByType": {}, "resourceUrls": [] } } } }, { "title": "有状态会员资源校验（场景B）", "method": "POST", "path": "/openapi/memberships/resources/check", "description": "返回与 /openapi/permissions/check 一致的资源结构，并叠加有状态会员有效性+系统支持约束。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "用户登录令牌，格式 Bearer TOKEN" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码" }, { "name": "X-Site", "type": "string", "required": true, "description": "站点标识" } ] }, "responseExample": { "success": { "code": "0000", "message": "校验通过", "data": { "resources": [], "resourcesByType": {}, "resourceUrls": [] } } } }, { "title": "有状态会员资源校验（场景C）", "method": "POST", "path": "/openapi/memberships/resources/functionCheck", "description": "返回与 /openapi/permissions/check 一致的资源结构，并叠加有状态会员有效性+系统约束。系统会自动解析该会员在当前系统下已授权的模块，并返回对应模块资源。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "用户登录令牌，格式 Bearer TOKEN" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码" }, { "name": "X-Site", "type": "string", "required": true, "description": "站点标识" } ] }, "responseExample": { "success": { "code": "0000", "message": "校验通过", "data": { "resources": [], "resourcesByType": {}, "resourceUrls": [] } } } }, { "title": "有状态会员资源校验（场景D）", "method": "POST", "path": "/openapi/memberships/resources/limitCheck", "description": "返回与 /openapi/permissions/check 一致的资源结构，并叠加有状态会员有效性+系统+限额约束。系统会自动按会员在当前系统下已授权模块过滤资源，并对这些模块应用限额筛选。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "用户登录令牌，格式 Bearer TOKEN" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码" }, { "name": "X-Site", "type": "string", "required": true, "description": "站点标识" } ], "body": { "currentCount": "number｜必填，当前已使用次数/数量" } }, "responseExample": { "success": { "code": "0000", "message": "校验通过", "data": { "resources": [], "resourcesByType": {}, "resourceUrls": [] } } }, "notes": [ "必要参数要求与对应会员校验接口一致", "会员条件不满足时返回空资源，而不是抛错" ] }, { "title": "会员开通", "method": "POST", "path": "/openapi/memberships/activate", "description": "基于已支付订单为客户端用户开通会员资格，并自动同步会员用户记录和订单状态。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "客户端登录令牌，格式为 Bearer TOKEN" } ], "body": { "memberType": "string｜必填，会员类型编码或名称，如 VIP", "orderNo": "string｜必填，已支付订单号" } }, "responseExample": { "success": { "code": "0000", "message": "会员开通成功", "data": { "clientUser": { "id": "GplqNHbkcmcFa0sj", "code": "CU000009", "phone": "18347432461", "name": "Smkello" }, "memberUser": { "id": "toiUHzFoO1xtmSkI", "memberType": "VIP" }, "order": { "orderNo": "ORD-20250115-0010", "status": "COMPLETED" } } }, "failure": { "code": "1107", "message": "订单尚未支付或已失效", "data": null } }, "notes": [ "该接口会校验黑名单、订单手机号、订单状态与会员类型一致性。", "响应 Header X-OpenAPI-Result 存放加密结果用于客户端追踪。" ] }, { "title": "会员注册", "method": "POST", "path": "/openapi/memberships/register", "description": "根据注册令牌中的信息自动落地企业或散客账号。如果启用了站点分配，会为用户创建个人站点和独立数据库，并自动创建超级管理员角色。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "注册令牌，服务端提前生成，格式为 Bearer TOKEN" }, { "name": "X-Site", "type": "string", "required": true, "description": "所属站点标识，用户将注册到该站点" } ] }, "responseExample": { "success": { "code": "0000", "message": "会员注册成功", "data": { "accountType": "company", "user": { "id": "BAKj1wKp7etrmSAT", "code": "USER000001", "name": "企业管理员", "title": "企业管理员", "phone": "13800138000", "email": "admin@example.com", "phonePrefix": "+86", "individualism": true, "status": 1, "roles": [], "effectiveDate": "2025-01-21", "expiryDate": null, "createTime": "2025-01-21T10:00:00.000Z", "updateTime": "2025-01-21T10:00:00.000Z", "creator": "13800138000", "updater": "13800138000" }, "organization": { "code": "ORG000001", "name": "靖苒数字" }, "site": { "id": "site-id", "key": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890-ABCDEF12", "name": "个人站点", "createTime": "2025-01-21T10:00:00.000Z" } } }, "failure": { "code": "1203", "message": "公司信用代码已注册", "data": null } }, "notes": [ "当注册信息包含公司名称与信用代码时将自动创建企业账号及组织根节点；否则注册为散客账号。", "密码要求同时包含字母和数字，长度不少于 6 位。", "如果启用了站点分配，系统会：1. 在所属站点数据库创建用户 2. 创建个人站点和独立数据库 3. 在独立数据库中创建用户副本和超级管理员角色", "X-Site header 必传，用于指定用户所属的站点" ] }, { "title": "会员登录", "method": "POST", "path": "/openapi/memberships/login", "description": "同时支持企业账号与散客账号的登录校验，并返回加密的登录令牌。如果用户有多个可用站点，会返回站点信息。散客账号登录时必须包含同意协议字段。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "登录令牌，包含手机号、密码和同意协议信息（散客账号必填），格式为 Bearer TOKEN。令牌 payload 应包含：phone（手机号）、password（密码）、agreeTerms（同意协议，散客账号必填且必须为 true）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码。用于指定当前登录的业务系统（例如 AUTH_MANAGEMENT、CONTENT_MANAGEMENT）。当系统不支持时将返回“登录用户不支持当前系统，可联系管理员处理”。" } ] }, "responseExample": { "success": { "code": "0000", "message": "登录成功", "data": { "token": "eyJhbGciOiJIUzI1NiIs...", "user": { "id": "BAKj1wKp7etrmSAT", "code": "USER000001", "username": "企业管理员", "phone": "13800138000", "email": "admin@example.com", "individualism": true, "status": 1, "createTime": "2025-01-21T10:00:00.000Z", "accountType": "user", "type": "普通用户" }, "companyName": "靖苒数字", "site": { "id": "site-id", "key": "56B57A72-59C4-460B-82E5-22196205391B-A4608B6E9D4D6F599", "name": "所属站点", "createTime": "2025-01-21T10:00:00.000Z" } } }, "failure": { "code": "1302", "message": "当前账号处于黑名单状态", "data": null }, "failureAgreeTerms": { "code": "1303", "message": "请同意隐私等协议", "data": null } }, "notes": [ "优先尝试企业账号登录，失败后自动回退到散客账号校验。", "散客账号登录时，登录令牌的 payload 中必须包含 agreeTerms 字段且值为 true，否则返回错误码 1303（请同意隐私等协议）。", "企业账号登录时，agreeTerms 字段可选，不影响登录流程。", "成功时 data.token 与响应 Header X-OpenAPI-Result 均为加密令牌。", "响应中的 site 字段说明：", " - site 字段只返回个人站点信息（如果用户有个人站点），不会返回所属站点信息", " - 有个人站点时：site 字段包含个人站点的完整信息（id、key、name、createTime）", " - 无个人站点时：site 字段为 null（无论用户是否有所属站点）", " - 判断逻辑：只需判断 site 是否为 null 即可知道用户是否有个人站点", " - 注意：用户可能既有所属站点（通过 user.siteKey 访问），也有个人站点（通过 site 字段访问）", "后续请求可通过 X-Site header 切换站点，切换后使用对应站点的数据库。" ], "responseExamples": { "有个人站点": { "code": "0000", "message": "登录成功", "data": { "token": "eyJhbGciOiJIUzI1NiIs...", "user": { "id": "BAKj1wKp7etrmSAT", "code": "USER000001", "username": "企业管理员", "phone": "13800138000", "email": "admin@example.com", "individualism": true, "status": 1, "createTime": "2025-01-21T10:00:00.000Z", "accountType": "user", "type": "普通用户" }, "companyName": "靖苒数字", "site": { "id": "MNFIOHH6QOA3kg0z", "key": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890-ABCDEF12", "name": "个人站点", "createTime": "2025-01-21T10:00:00.000Z" } } }, "无个人站点": { "code": "0000", "message": "登录成功", "data": { "token": "eyJhbGciOiJIUzI1NiIs...", "user": { "id": "BAKj1wKp7etrmSAT", "code": "USER000001", "username": "企业管理员", "phone": "13800138000", "email": "admin@example.com", "individualism": false, "status": 1, "createTime": "2025-01-21T10:00:00.000Z", "accountType": "user", "type": "普通用户" }, "companyName": "靖苒数字", "site": null } } } }, { "title": "登录令牌校验", "method": "POST", "path": "/openapi/memberships/login/verify", "description": "对登录接口返回的访问令牌进行有效性校验，确认令牌是否过期、账号状态及黑名单状态。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "登录接口返回的访问令牌，格式为 Bearer TOKEN" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码。用于指定当前登录的业务系统（例如 AUTH_MANAGEMENT、CONTENT_MANAGEMENT）。当系统不支持时将返回“登录用户不支持当前系统，可联系管理员处理”。" } ] }, "responseExample": { "success": { "code": "0000", "message": "登录令牌校验成功", "data": { "phone": "13800138000", "id": "USER000001", "_id": "MNFIOHH6QOA3kg0z" } }, "failure": { "code": "1300", "message": "登录令牌无效或已过期", "data": null } }, "notes": [ "当令牌失效、对应账号被禁用或存在黑名单记录时也会返回 200，但 code 与 message 表示具体失败原因。", "若需要补充返回字段，可在 data 中扩展 additional 信息。", "支持通过 X-Site header 切换站点，切换后使用对应站点的数据库进行权限校验。" ] }, { "title": "资源权限校验", "method": "POST", "path": "/openapi/permissions/resource-check", "description": "基于登录令牌校验指定系统下用户是否拥有访问某接口所需的资源与权限。支持通过 X-Site header 切换站点。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "登录接口返回的访问令牌，格式为 Bearer TOKEN" }, { "name": "X-Site", "type": "string", "required": false, "description": "站点标识。用于切换站点和对应的数据库上下文。如果用户有多个可用站点，可通过此 header 切换。" } ], "body": { "systemCode": "string｜必填，目标系统编码", "apiName": "string｜必填，接口标识（可使用资源 code、name、title 或 URL）", "requiredPermissions": "string[]｜选填，需要同时具备的权限编码数组" } }, "responseExample": { "success": { "code": "0000", "message": "资源权限校验成功", "data": { "accessGranted": true, "user": { "id": "BAKj1wKp7etrmSAT", "phone": "13800138000", "type": "user" }, "system": { "code": "AUTH", "name": "权限管理系统" }, "resource": { "code": "API_CUSTOMER_DELETE", "url": "/api/customers/:id", "type": "api" }, "checkedPermissions": [ "CUSTOMER_DELETE" ] } }, "failure": { "code": "1502", "message": "缺少必要权限: CUSTOMER_DELETE", "data": null } }, "notes": [ "若找不到与 apiName 匹配的资源，将返回 code=1501。", "requiredPermissions 未传时仅校验资源授权，传入时要求全部命中。", "出于安全考虑，失败时同样返回 HTTP 200，但 code/message 用于区分失败原因。" ] }, { "title": "账户权限校验", "method": "POST", "path": "/openapi/permissions/check", "description": "根据访问令牌校验账户在指定系统下拥有的资源与权限。资源列表以树状结构返回，方便前端渲染菜单等场景。支持通过 X-Site header 切换站点。", "requestParams": { "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "访问令牌，支持系统用户与客户端用户，格式为 Bearer TOKEN" }, { "name": "X-Site", "type": "string", "required": false, "description": "站点标识。用于切换站点和对应的数据库上下文。如果用户有多个可用站点，可通过此 header 切换。" } ], "body": { "systemCode": "string｜必填，要校验的系统编码" } }, "responseExample": { "success": { "code": "0000", "message": "权限校验成功", "data": { "user": { "id": "MNFIOHH6QOA3kg0z", "code": "USER000001", "username": "企业管理员", "type": "user" }, "companyName": "靖苒数字", "system": { "code": "AUTH", "name": "权限管理系统" }, "resources": [ { "id": "RES001", "code": "RES001", "name": "内容管理", "title": "内容管理", "type": "page", "url": "/content", "parentId": null, "orderNum": 1, "children": [ { "id": "RES002", "code": "RES002", "name": "文章管理", "title": "文章管理", "type": "page", "url": "/content/articles", "parentId": "RES001", "orderNum": 1, "children": [] }, { "id": "RES003", "code": "RES003", "name": "分类管理", "title": "分类管理", "type": "page", "url": "/content/categories", "parentId": "RES001", "orderNum": 2, "children": [] } ] } ], "resourcesByType": { "page": [ { "id": "RES001", "code": "RES001", "name": "内容管理", "title": "内容管理", "type": "page", "url": "/content", "parentId": null, "orderNum": 1, "children": [ { "id": "RES002", "code": "RES002", "name": "文章管理", "title": "文章管理", "type": "page", "url": "/content/articles", "parentId": "RES001", "orderNum": 1, "children": [] }, { "id": "RES003", "code": "RES003", "name": "分类管理", "title": "分类管理", "type": "page", "url": "/content/categories", "parentId": "RES001", "orderNum": 2, "children": [] } ] } ], "button": [ { "id": "RES004", "code": "RES004", "name": "新增按钮", "title": "新增按钮", "type": "button", "url": "/api/content/create", "parentId": null, "orderNum": 1, "children": [] } ] }, "site": { "id": "site-id", "key": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890-ABCDEF12", "name": "个人站点", "createTime": "2025-01-21T10:00:00.000Z" } } }, "failure": { "code": "1402", "message": "系统未开放或已停用", "data": null } }, "notes": [ "企业账号会同时合并个人权限与所属组织权限；散客账号仅返回个人权限。", "权限列表来自角色继承链，请根据资源类型及 resourceUrls 进行前端路由控制。", "resources 字段返回树状结构，每个资源节点包含 children 数组，用于前端渲染菜单树。树状结构按 orderNum 排序。", "resourcesByType 字段按资源类型分组返回，每个类型下的资源也是树状结构，方便前端按类型渲染。", "支持通过 X-Site header 切换站点，切换后使用对应站点的数据库进行权限查询，返回该站点下的角色和权限。" ] }, { "title": "激活无状态会员", "method": "POST", "path": "/openapi/stateless-members/activate", "description": "激活无状态会员，通过X-Member-Key header中的混合JWT解密得到密钥，校验会员有效性后生成新的密钥令牌返回。", "requestParams": { "headers": [ { "name": "X-Member-Key", "type": "string", "required": true, "description": "会员密钥令牌，通过混合JWT加密" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码，用于判断会员类型是否支持当前系统" }, { "name": "X-Site", "type": "string", "required": true, "description": "站点标识" } ] }, "responseExample": { "success": { "code": "0000", "message": "激活成功", "data": { "keyToken": "新的密钥令牌（混合JWT加密）", "member": { "id": "xxx", "code": "SM0001", "name": "无状态会员", "memberTypeId": "yyy", "effectiveDate": "2025-01-01", "validityDays": 365 } } }, "failure": { "code": "1504", "message": "您绑定的会员码无效", "data": null }, "failureExpired": { "code": "1501", "message": "激活已超时，请重新绑定激活", "data": null } }, "notes": [ "如果X-Member-Key的JWT解析已过期，返回错误：激活已超时，请重新绑定激活", "校验无状态密钥是否存在且有效，且没有过期", "校验关联会员类型记录是否存在且有效", "通过X-System-Code判断会员类型是否支持当前系统", "校验通过后，用混合JWT加密生成新的密钥返回", "不满足条件返回：您绑定的会员码无效" ] }, { "title": "检查无状态会员有效性", "method": "POST", "path": "/openapi/stateless-members/check", "description": "检查无状态会员是否还有效，通过X-Member-Key header中的混合JWT解密得到密钥，校验会员状态、过期时间、系统支持等，返回剩余天数。", "requestParams": { "headers": [ { "name": "X-Member-Key", "type": "string", "required": true, "description": "会员密钥令牌，通过混合JWT加密" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码，用于判断会员类型是否支持当前系统" }, { "name": "X-Site", "type": "string", "required": true, "description": "站点标识" } ] }, "responseExample": { "success": { "code": "0000", "message": "校验通过", "data": { "valid": true, "remainingDays": 30, "member": { "id": "xxx", "code": "SM0001", "name": "无状态会员", "memberTypeId": "yyy", "effectiveDate": "2025-01-01", "validityDays": 365 } } }, "failure": { "code": "1506", "message": "您绑定的会员无效", "data": null }, "failureExpired": { "code": "1505", "message": "传入的会员需要重新绑定", "data": null }, "failureMemberExpired": { "code": "1507", "message": "会员已过期", "data": null } }, "notes": [ "如果X-Member-Key的JWT解析已过期，返回错误：传入的会员需要重新绑定", "判断无状态密钥是否存在且有效", "关联会员类型记录是否存在且有效，不存在或无效返回：您绑定的会员无效", "判断是否过期，已过期返回：会员已过期", "通过X-System-Code判断会员类型是否支持当前系统，不支持返回：当前会员码不支持当前系统", "返回会员还有多少天到期（基于会员有效期、当天日期、会员生效日期计算剩余时间按天计）", "不满足条件返回：您绑定的会员码无效" ] }, { "title": "检查无状态会员功能有效性", "method": "POST", "path": "/openapi/stateless-members/functionCheck", "description": "在检查无状态会员有效性的基础上，额外通过X-Function header检查会员功能模块中是否有该功能。", "requestParams": { "headers": [ { "name": "X-Member-Key", "type": "string", "required": true, "description": "会员密钥令牌，通过混合JWT加密" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码，用于判断会员类型是否支持当前系统" }, { "name": "X-Function", "type": "string", "required": true, "description": "功能代码，用于检查会员功能模块中是否有该功能" }, { "name": "X-Site", "type": "string", "required": true, "description": "站点标识" } ] }, "responseExample": { "success": { "code": "0000", "message": "校验通过", "data": { "valid": true, "remainingDays": 30, "member": { "id": "xxx", "code": "SM0001", "name": "无状态会员", "memberTypeId": "yyy", "effectiveDate": "2025-01-01", "validityDays": 365 }, "function": { "code": "FUNC001", "name": "功能名称", "type": "Resource" } } }, "failure": { "code": "1508", "message": "当前会员不支持当前功能", "data": null } }, "notes": [ "在/stateless-members/check功能基础上，通过Header的X-Function额外检查会员功能模块", "如果会员功能模块中有该功能则通过，没有则返回：当前会员不支持当前功能", "支持通过moduleCode或moduleId查找功能模块", "功能模块类型可以是Resource（绑定资源）或Custom（自定义模块名称）" ] }, { "title": "无状态会员有效性校验（场景A）", "method": "POST", "path": "/openapi/stateless-members/valid-check", "description": "场景A：仅校验无状态会员是否有效（未过期），不校验会员类型与系统的支持关系。适用于第三方只需确认会员是否开通且未到期的简单场景。", "requestParams": { "headers": [ { "name": "X-Member-Key", "type": "string", "required": true, "description": "会员密钥令牌（混合JWT加密，payload.data = secretKey）" }, { "name": "X-Site", "type": "string", "required": true, "description": "站点标识" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（用于路由到正确数据库，本接口不校验系统-会员类型兼容性）" } ] }, "responseExamples": { "校验通过": { "code": "0000", "message": "会员有效", "data": { "valid": true, "remainingDays": 25, "memberType": { "id": "xxx", "name": "黄金会员", "code": "H001" }, "member": { "id": "yyy", "code": "SM000001", "name": "新人可享", "effectiveDate": "2026-03-01", "validityDays": 30 } } }, "会员已过期": { "code": "1005", "message": "会员已过期", "data": null }, "密钥需重新绑定": { "code": "1505", "message": "传入的会员需要重新绑定", "data": null }, "会员码无效": { "code": "1504", "message": "您绑定的会员码无效", "data": null } }, "notes": [ "X-Member-Key 为激活接口返回的 keyToken（混合JWT），到期后需重新调用 /activate 接口", "本接口不校验系统支持关系，适合场景A（只验有效性）", "场景B（验系统支持）请使用 /stateless-members/check", "场景C（验功能模块）请使用 /stateless-members/functionCheck", "场景D（验功能限额）请使用 /stateless-members/limitCheck" ] }, { "title": "无状态会员限额校验（场景D）", "method": "POST", "path": "/openapi/stateless-members/limitCheck", "description": "场景D：在场景C（功能模块校验）的基础上，进一步校验当前功能模块的使用量是否已达到配置的上限（limitValue）。适用于有次数或存储上限控制的业务场景。", "requestParams": { "headers": [ { "name": "X-Member-Key", "type": "string", "required": true, "description": "会员密钥令牌（混合JWT加密）" }, { "name": "X-Site", "type": "string", "required": true, "description": "站点标识" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码" }, { "name": "X-Function", "type": "string", "required": true, "description": "功能模块代码（moduleCode），如 VIDEO_DOWNLOAD" } ], "body": { "currentCount": "number｜必填，当前已使用次数/数量（由第三方系统维护），如 8" } }, "responseExamples": { "校验通过（有限额）": { "code": "0000", "message": "校验通过", "data": { "valid": true, "remainingDays": 25, "memberType": { "id": "xxx", "name": "黄金会员", "code": "H001" }, "member": { "id": "yyy", "code": "SM000001", "name": "新人可享", "effectiveDate": "2026-03-01", "validityDays": 30 }, "system": { "code": "system-b", "name": "系统B" }, "function": { "code": "VIDEO_DOWNLOAD", "name": "视频下载" }, "limit": { "value": 10, "current": 8, "remaining": 2 } } }, "校验通过（无限额）": { "code": "0000", "message": "校验通过", "data": { "valid": true, "remainingDays": 25, "limit": null } }, "已达使用上限": { "code": "1010", "message": "当前功能使用已达上限（10）", "data": { "limitValue": 10, "currentCount": 10 } }, "会员不支持该功能": { "code": "1508", "message": "当前会员不支持当前功能", "data": null }, "会员类型未授权系统": { "code": "1007", "message": "会员类型未授权当前系统", "data": null } }, "notes": [ "limit 字段为 null 表示该功能未配置限额，即不限次数", "limit.remaining = limit.value - currentCount，小于等于0时拒绝", "currentCount 由第三方系统自行维护并传入，本系统不做存储", "限额配置在管理后台 会员功能限制（memberFunctionLimits）中设置" ] }, { "title": "用户管理 - 分页列表查询", "method": "GET", "path": "/openapi/users/list", "description": "分页查询用户管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "USER0001", "name": "张三", "title": "系统管理员", "phone": "13800138000", "email": "zhangsan@example.com", "phonePrefix": "+86", "status": 1, "roles": [ "ROLE0001" ], "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "用户管理 - 简单列表查询", "method": "GET", "path": "/openapi/users/list/simple", "description": "无分页返回用户管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "USER0001", "name": "张三", "title": "系统管理员", "phone": "13800138000", "email": "zhangsan@example.com", "phonePrefix": "+86", "status": 1, "roles": [ "ROLE0001" ], "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "客户端用户管理 - 分页列表查询", "method": "GET", "path": "/openapi/client-users/list", "description": "分页查询客户端用户管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "CU0001", "name": "客户端用户", "phone": "13900139000", "email": "client@example.com", "phonePrefix": "+86", "status": 1, "agreeTerms": true, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "客户端用户管理 - 简单列表查询", "method": "GET", "path": "/openapi/client-users/list/simple", "description": "无分页返回客户端用户管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "CU0001", "name": "客户端用户", "phone": "13900139000", "email": "client@example.com", "phonePrefix": "+86", "status": 1, "agreeTerms": true, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "组织管理 - 分页列表查询", "method": "GET", "path": "/openapi/organizations/list", "description": "分页查询组织管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "ORG0001", "name": "测试公司", "title": "测试公司有限公司", "description": "测试公司描述", "status": 1, "parentId": null, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "组织管理 - 简单列表查询", "method": "GET", "path": "/openapi/organizations/list/simple", "description": "无分页返回组织管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "ORG0001", "name": "测试公司", "title": "测试公司有限公司", "description": "测试公司描述", "status": 1, "parentId": null, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "部门管理 - 分页列表查询", "method": "GET", "path": "/openapi/departments/list", "description": "分页查询部门管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "DEPT0001", "name": "技术部", "title": "技术开发部", "description": "技术开发部门", "status": 1, "organizationId": "ORG0001", "parentId": null, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "部门管理 - 简单列表查询", "method": "GET", "path": "/openapi/departments/list/simple", "description": "无分页返回部门管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "DEPT0001", "name": "技术部", "title": "技术开发部", "description": "技术开发部门", "status": 1, "organizationId": "ORG0001", "parentId": null, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "岗位管理 - 分页列表查询", "method": "GET", "path": "/openapi/positions/list", "description": "分页查询岗位管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "POS0001", "name": "高级工程师", "title": "高级开发工程师", "description": "高级开发工程师岗位", "status": 1, "orderNum": 1, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "岗位管理 - 简单列表查询", "method": "GET", "path": "/openapi/positions/list/simple", "description": "无分页返回岗位管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "POS0001", "name": "高级工程师", "title": "高级开发工程师", "description": "高级开发工程师岗位", "status": 1, "orderNum": 1, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "职员管理 - 分页列表查询", "method": "GET", "path": "/openapi/staff/list", "description": "分页查询职员管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "STAFF0001", "name": "李四", "title": "技术部员工", "phone": "13700137000", "email": "lisi@example.com", "status": 1, "departmentId": "DEPT0001", "positionId": "POS0001", "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "职员管理 - 简单列表查询", "method": "GET", "path": "/openapi/staff/list/simple", "description": "无分页返回职员管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "STAFF0001", "name": "李四", "title": "技术部员工", "phone": "13700137000", "email": "lisi@example.com", "status": 1, "departmentId": "DEPT0001", "positionId": "POS0001", "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "角色管理 - 分页列表查询", "method": "GET", "path": "/openapi/roles/list", "description": "分页查询角色管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "ROLE0001", "name": "管理员", "title": "系统管理员", "type": "system", "description": "系统管理员角色", "status": 1, "orderNum": 1, "permissions": [ "PERM0001" ], "resources": [ "RES0001" ], "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "角色管理 - 简单列表查询", "method": "GET", "path": "/openapi/roles/list/simple", "description": "无分页返回角色管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "ROLE0001", "name": "管理员", "title": "系统管理员", "type": "system", "description": "系统管理员角色", "status": 1, "orderNum": 1, "permissions": [ "PERM0001" ], "resources": [ "RES0001" ], "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "资源管理 - 分页列表查询", "method": "GET", "path": "/openapi/resources/list", "description": "分页查询资源管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "RES0001", "name": "用户管理", "title": "用户管理模块", "type": "page", "description": "用户管理页面资源", "status": 1, "url": "/users", "icon": "user", "orderNum": 1, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "资源管理 - 简单列表查询", "method": "GET", "path": "/openapi/resources/list/simple", "description": "无分页返回资源管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "RES0001", "name": "用户管理", "title": "用户管理模块", "type": "page", "description": "用户管理页面资源", "status": 1, "url": "/users", "icon": "user", "orderNum": 1, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "权限管理 - 分页列表查询", "method": "GET", "path": "/openapi/permissions/list", "description": "分页查询权限管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "PERM0001", "name": "用户查看", "title": "用户查看权限", "type": "global", "description": "用户查看权限", "status": 1, "orderNum": 1, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "权限管理 - 简单列表查询", "method": "GET", "path": "/openapi/permissions/list/simple", "description": "无分页返回权限管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "PERM0001", "name": "用户查看", "title": "用户查看权限", "type": "global", "description": "用户查看权限", "status": 1, "orderNum": 1, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "客户管理 - 分页列表查询", "method": "GET", "path": "/openapi/customers/list", "description": "分页查询客户管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "CUST0001", "name": "客户A", "title": "客户A公司", "phone": "13600136000", "email": "customer@example.com", "address": "北京市朝阳区", "status": 1, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "客户管理 - 简单列表查询", "method": "GET", "path": "/openapi/customers/list/simple", "description": "无分页返回客户管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "CUST0001", "name": "客户A", "title": "客户A公司", "phone": "13600136000", "email": "customer@example.com", "address": "北京市朝阳区", "status": 1, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "订单管理 - 分页列表查询", "method": "GET", "path": "/openapi/orders/list", "description": "分页查询订单管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "ORDER0001", "orderNo": "ORD20250101001", "orderType": "MEMBER", "orderName": "会员订单", "orderDetail": "会员开通订单", "orderPhone": "13800138000", "amount": 99, "status": "PAID", "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "订单管理 - 简单列表查询", "method": "GET", "path": "/openapi/orders/list/simple", "description": "无分页返回订单管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "ORDER0001", "orderNo": "ORD20250101001", "orderType": "MEMBER", "orderName": "会员订单", "orderDetail": "会员开通订单", "orderPhone": "13800138000", "amount": 99, "status": "PAID", "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "会员管理 - 分页列表查询", "method": "GET", "path": "/openapi/members/list", "description": "分页查询会员管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "MEMBER0001", "name": "会员A", "description": "会员描述", "status": 1, "memberTypeId": "MT0001", "price": "99.00", "validityDays": 365, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "会员管理 - 简单列表查询", "method": "GET", "path": "/openapi/members/list/simple", "description": "无分页返回会员管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "MEMBER0001", "name": "会员A", "description": "会员描述", "status": 1, "memberTypeId": "MT0001", "price": "99.00", "validityDays": 365, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "无状态会员管理 - 分页列表查询", "method": "GET", "path": "/openapi/stateless-members/list", "description": "分页查询无状态会员管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "SM0001", "name": "无状态会员", "description": "无状态会员描述", "status": 1, "memberTypeId": "MT0001", "validityDays": 365, "effectiveDate": "2025-01-01", "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "无状态会员管理 - 简单列表查询", "method": "GET", "path": "/openapi/stateless-members/list/simple", "description": "无分页返回无状态会员管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "SM0001", "name": "无状态会员", "description": "无状态会员描述", "status": 1, "memberTypeId": "MT0001", "validityDays": 365, "effectiveDate": "2025-01-01", "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "会员用户管理 - 分页列表查询", "method": "GET", "path": "/openapi/member-users/list", "description": "分页查询会员用户管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "MU0001", "memberId": "MEMBER0001", "userId": "USER0001", "status": 1, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "会员用户管理 - 简单列表查询", "method": "GET", "path": "/openapi/member-users/list/simple", "description": "无分页返回会员用户管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "MU0001", "memberId": "MEMBER0001", "userId": "USER0001", "status": 1, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "会员功能管理 - 分页列表查询", "method": "GET", "path": "/openapi/member-functions/list", "description": "分页查询会员功能管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "memberTypeId": "MT0001", "memberTypeName": "VIP会员", "systemId": "SYS0001", "systemName": "权限系统", "status": 1, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "会员功能管理 - 简单列表查询", "method": "GET", "path": "/openapi/member-functions/list/simple", "description": "无分页返回会员功能管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "memberTypeId": "MT0001", "memberTypeName": "VIP会员", "systemId": "SYS0001", "systemName": "权限系统", "status": 1, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "会员类型管理 - 分页列表查询", "method": "GET", "path": "/openapi/member-types/list", "description": "分页查询会员类型管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "MT0001", "name": "VIP会员", "title": "VIP会员类型", "description": "VIP会员类型描述", "status": 1, "price": "99.00", "validityDays": 365, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "会员类型管理 - 简单列表查询", "method": "GET", "path": "/openapi/member-types/list/simple", "description": "无分页返回会员类型管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "MT0001", "name": "VIP会员", "title": "VIP会员类型", "description": "VIP会员类型描述", "status": 1, "price": "99.00", "validityDays": 365, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "会员功能限制管理 - 分页列表查询", "method": "GET", "path": "/openapi/member-function-limits/list", "description": "分页查询会员功能限制管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "memberTypeId": "MT0001", "memberTypeName": "VIP会员", "systemId": "SYS0001", "systemName": "权限系统", "moduleId": "MOD0001", "moduleName": "用户管理", "limitValue": 100, "status": 1, "description": "会员功能限制描述", "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "会员功能限制管理 - 简单列表查询", "method": "GET", "path": "/openapi/member-function-limits/list/simple", "description": "无分页返回会员功能限制管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "memberTypeId": "MT0001", "memberTypeName": "VIP会员", "systemId": "SYS0001", "systemName": "权限系统", "moduleId": "MOD0001", "moduleName": "用户管理", "limitValue": 100, "status": 1, "description": "会员功能限制描述", "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "白名单管理 - 分页列表查询", "method": "GET", "path": "/openapi/whitelists/list", "description": "分页查询白名单管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "WL0001", "name": "白名单A", "userId": "USER0001", "ip": "192.168.1.1", "description": "白名单描述", "status": 1, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "白名单管理 - 简单列表查询", "method": "GET", "path": "/openapi/whitelists/list/simple", "description": "无分页返回白名单管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "WL0001", "name": "白名单A", "userId": "USER0001", "ip": "192.168.1.1", "description": "白名单描述", "status": 1, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "黑名单管理 - 分页列表查询", "method": "GET", "path": "/openapi/blacklists/list", "description": "分页查询黑名单管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "BL0001", "name": "黑名单A", "userId": "USER0001", "ip": "192.168.1.100", "description": "黑名单描述", "status": 1, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "黑名单管理 - 简单列表查询", "method": "GET", "path": "/openapi/blacklists/list/simple", "description": "无分页返回黑名单管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "BL0001", "name": "黑名单A", "userId": "USER0001", "ip": "192.168.1.100", "description": "黑名单描述", "status": 1, "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "系统管理 - 分页列表查询", "method": "GET", "path": "/openapi/support-systems/list", "description": "分页查询系统管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "pageNum", "type": "number", "required": false, "description": "页码，默认1" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量，默认10" }, { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "SYS0001", "name": "权限管理系统", "description": "权限管理系统描述", "status": 1, "defaultAdminRoleId": "ROLE0001", "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ], "total": 1, "pageNum": 1, "pageSize": 10 } } }, "notes": [ "只返回状态为有效的记录（status=1）", "支持多种可选查询条件进行筛选", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "系统管理 - 简单列表查询", "method": "GET", "path": "/openapi/support-systems/list/simple", "description": "无分页返回系统管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" }, { "name": "sortBy", "type": "string", "required": false, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "type": "string", "required": false, "description": "排序方向：asc-升序，desc-降序，默认desc" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "id": 1, "code": "SYS0001", "name": "权限管理系统", "description": "权限管理系统描述", "status": 1, "defaultAdminRoleId": "ROLE0001", "createTime": "2025-01-01T10:00:00.000Z", "updateTime": "2025-01-01T10:00:00.000Z" } ] } } }, "notes": [ "只返回状态为有效的记录（status=1）", "最多返回100条数据", "支持多种可选查询条件进行筛选", "支持排序功能", "必须提供有效的X-Site header，查询对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "站点数据 - 列表查询", "method": "GET", "path": "/openapi/sites/list", "description": "返回用户名和对应站点key的列表，用于查看。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "站点名称（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "userName": "张三", "siteKey": "47F38C4F-3437-4108-96EE-0621B30EF2B9-7B75868C742688BD3", "siteName": "个人站点" } ] } } }, "notes": [ "返回用户名和对应站点key", "必须提供有效的X-Site header", "必须提供有效的X-System-Code header" ] } ] }, { "module": "统计模块", "moduleKey": "statistics", "apiCount": 21, "apis": [ { "title": "用户管理 - 统计", "method": "GET", "path": "/openapi/users/statistics", "description": "返回用户管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "客户端用户管理 - 统计", "method": "GET", "path": "/openapi/client-users/statistics", "description": "返回客户端用户管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "组织管理 - 统计", "method": "GET", "path": "/openapi/organizations/statistics", "description": "返回组织管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "部门管理 - 统计", "method": "GET", "path": "/openapi/departments/statistics", "description": "返回部门管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "岗位管理 - 统计", "method": "GET", "path": "/openapi/positions/statistics", "description": "返回岗位管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "职员管理 - 统计", "method": "GET", "path": "/openapi/staff/statistics", "description": "返回职员管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "角色管理 - 统计", "method": "GET", "path": "/openapi/roles/statistics", "description": "返回角色管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "资源管理 - 统计", "method": "GET", "path": "/openapi/resources/statistics", "description": "返回资源管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "权限管理 - 统计", "method": "GET", "path": "/openapi/permissions/statistics", "description": "返回权限管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "客户管理 - 统计", "method": "GET", "path": "/openapi/customers/statistics", "description": "返回客户管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "订单管理 - 统计", "method": "GET", "path": "/openapi/orders/statistics", "description": "返回订单管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "会员管理 - 统计", "method": "GET", "path": "/openapi/members/statistics", "description": "返回会员管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "无状态会员管理 - 统计", "method": "GET", "path": "/openapi/stateless-members/statistics", "description": "返回无状态会员管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "会员用户管理 - 统计", "method": "GET", "path": "/openapi/member-users/statistics", "description": "返回会员用户管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "会员功能管理 - 统计", "method": "GET", "path": "/openapi/member-functions/statistics", "description": "返回会员功能管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "会员类型管理 - 统计", "method": "GET", "path": "/openapi/member-types/statistics", "description": "返回会员类型管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "会员功能限制管理 - 统计", "method": "GET", "path": "/openapi/member-function-limits/statistics", "description": "返回会员功能限制管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "白名单管理 - 统计", "method": "GET", "path": "/openapi/whitelists/statistics", "description": "返回白名单管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "黑名单管理 - 统计", "method": "GET", "path": "/openapi/blacklists/statistics", "description": "返回黑名单管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "系统管理 - 统计", "method": "GET", "path": "/openapi/support-systems/statistics", "description": "返回系统管理的有效数据记录数和所有记录数两个字段。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ], "query": [ { "name": "name", "type": "string", "required": false, "description": "名称（模糊搜索）" }, { "name": "code", "type": "string", "required": false, "description": "编码（模糊搜索）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 100, "totalCount": 150 } } }, "notes": [ "返回有效数据记录数（status=1）和所有记录数", "支持可选查询条件进行筛选", "必须提供有效的X-Site header，统计对应站点的数据", "必须提供有效的X-System-Code header，支持客户端系统" ] }, { "title": "站点数据 - 统计", "method": "GET", "path": "/openapi/sites/statistics", "description": "返回站点记录数。必须提供有效的X-Site和X-System-Code header。", "requestParams": { "headers": [ { "name": "X-Site", "type": "string", "required": true, "description": "站点标识（必填）" }, { "name": "X-System-Code", "type": "string", "required": true, "description": "系统编码（必填）" } ] }, "responseExample": { "success": { "code": "0000", "message": "统计成功", "data": { "validCount": 10, "totalCount": 10 } } }, "notes": [ "返回站点记录数", "必须提供有效的X-Site header", "必须提供有效的X-System-Code header" ] } ] } ] }