{ "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" ] } ] }