{ "openapi": "3.0.3", "info": { "title": "OpenAPI 接口", "version": "1.0.0", "description": "OpenAPI 接口相关接口文档" }, "paths": { "/openapi/memberships/valid-check": { "post": { "summary": "有状态会员有效性校验（场景A）", "description": "场景A：校验已登录用户的会员是否有效（未过期），不校验系统支持。适用于第三方已持有用户登录令牌，只需确认该用户是否有效会员的场景。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "用户登录令牌，格式 Bearer TOKEN（通过 /memberships/login 获取）", "example": "Bearer {token}" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（用于路由到正确数据库）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "code": "0000", "message": "成功" } } } } } } }, "/openapi/memberships/check": { "post": { "summary": "有状态会员系统支持校验（场景B）", "description": "场景B：校验已登录用户的会员有效性，并校验该用户的会员类型是否已配置支持指定系统。适用于系统级访问控制，如黄金会员才能访问系统B。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "用户登录令牌，格式 Bearer TOKEN", "example": "Bearer {token}" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码，同时作为校验目标（会员类型是否支持该系统）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "code": "0000", "message": "成功" } } } } } } }, "/openapi/memberships/functionCheck": { "post": { "summary": "有状态会员功能模块校验（场景C）", "description": "场景C：在场景B基础上，进一步校验该用户的会员类型在指定系统下是否开通了特定功能模块。适用于菜单/功能级别的精细控制。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "用户登录令牌，格式 Bearer TOKEN", "example": "Bearer {token}" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码" }, { "name": "X-Function", "in": "header", "required": true, "schema": { "type": "string" }, "description": "功能模块代码（moduleCode），如 VIDEO_DOWNLOAD" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "code": "0000", "message": "成功" } } } } } } }, "/openapi/memberships/limitCheck": { "post": { "summary": "有状态会员限额校验（场景D）", "description": "场景D：在场景C基础上，进一步校验当前功能模块的使用量是否已达配置上限。适用于有存储量/次数上限的业务，如最多保存10条数据。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "用户登录令牌，格式 Bearer TOKEN", "example": "Bearer {token}" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码" }, { "name": "X-Function", "in": "header", "required": true, "schema": { "type": "string" }, "description": "功能模块代码" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currentCount": { "type": "number", "description": "number｜必填，当前已使用次数/数量（由第三方系统维护）" } }, "required": [ "currentCount" ] } } } }, "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "code": "0000", "message": "成功" } } } } } } }, "/openapi/stateless-members/resources/valid-check": { "post": { "summary": "无状态会员资源校验（场景A）", "description": "返回与 /openapi/permissions/check 一致的资源结构，并叠加无状态会员有效性约束（仅校验会员有效）。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "账号登录令牌，格式 Bearer TOKEN", "example": "Bearer {token}" }, { "name": "X-Member-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "会员密钥令牌" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "校验通过", "data": { "user": { "id": "u001", "code": "CU000001", "username": "张三", "type": "clientUser" }, "resources": [], "resourcesByType": {}, "resourceUrls": [] } } } } } } } } }, "/openapi/stateless-members/resources/check": { "post": { "summary": "无状态会员资源校验（场景B）", "description": "返回与 /openapi/permissions/check 一致的资源结构，并叠加无状态会员有效性+系统支持约束。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "账号登录令牌，格式 Bearer TOKEN", "example": "Bearer {token}" }, { "name": "X-Member-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "会员密钥令牌" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "校验通过", "data": { "system": { "code": "AUTH_MANAGEMENT", "name": "权限管理系统" }, "resources": [], "resourcesByType": {}, "resourceUrls": [] } } } } } } } } }, "/openapi/stateless-members/resources/functionCheck": { "post": { "summary": "无状态会员资源校验（场景C）", "description": "返回与 /openapi/permissions/check 一致的资源结构，并叠加无状态会员有效性+系统约束。系统会自动解析该会员在当前系统下已授权的模块，并返回对应模块资源。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "账号登录令牌，格式 Bearer TOKEN", "example": "Bearer {token}" }, { "name": "X-Member-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "会员密钥令牌" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "校验通过", "data": { "resources": [], "resourcesByType": {}, "resourceUrls": [] } } } } } } } } }, "/openapi/stateless-members/resources/limitCheck": { "post": { "summary": "无状态会员资源校验（场景D）", "description": "返回与 /openapi/permissions/check 一致的资源结构，并叠加无状态会员有效性+系统+限额约束。系统会自动按会员在当前系统下已授权模块过滤资源，并对这些模块应用限额筛选。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "账号登录令牌，格式 Bearer TOKEN", "example": "Bearer {token}" }, { "name": "X-Member-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "会员密钥令牌" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currentCount": { "type": "number", "description": "number｜必填，当前已使用次数/数量" } }, "required": [ "currentCount" ] } } } }, "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "校验通过", "data": { "resources": [], "resourcesByType": {}, "resourceUrls": [] } } } } } } } } }, "/openapi/memberships/resources/valid-check": { "post": { "summary": "有状态会员资源校验（场景A）", "description": "返回与 /openapi/permissions/check 一致的资源结构，并叠加有状态会员有效性约束。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "用户登录令牌，格式 Bearer TOKEN", "example": "Bearer {token}" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "校验通过", "data": { "resources": [], "resourcesByType": {}, "resourceUrls": [] } } } } } } } } }, "/openapi/memberships/resources/check": { "post": { "summary": "有状态会员资源校验（场景B）", "description": "返回与 /openapi/permissions/check 一致的资源结构，并叠加有状态会员有效性+系统支持约束。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "用户登录令牌，格式 Bearer TOKEN", "example": "Bearer {token}" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "校验通过", "data": { "resources": [], "resourcesByType": {}, "resourceUrls": [] } } } } } } } } }, "/openapi/memberships/resources/functionCheck": { "post": { "summary": "有状态会员资源校验（场景C）", "description": "返回与 /openapi/permissions/check 一致的资源结构，并叠加有状态会员有效性+系统约束。系统会自动解析该会员在当前系统下已授权的模块，并返回对应模块资源。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "用户登录令牌，格式 Bearer TOKEN", "example": "Bearer {token}" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "校验通过", "data": { "resources": [], "resourcesByType": {}, "resourceUrls": [] } } } } } } } } }, "/openapi/memberships/resources/limitCheck": { "post": { "summary": "有状态会员资源校验（场景D）", "description": "返回与 /openapi/permissions/check 一致的资源结构，并叠加有状态会员有效性+系统+限额约束。系统会自动按会员在当前系统下已授权模块过滤资源，并对这些模块应用限额筛选。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "用户登录令牌，格式 Bearer TOKEN", "example": "Bearer {token}" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currentCount": { "type": "number", "description": "number｜必填，当前已使用次数/数量" } }, "required": [ "currentCount" ] } } } }, "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "校验通过", "data": { "resources": [], "resourcesByType": {}, "resourceUrls": [] } } } } } } } } }, "/openapi/memberships/activate": { "post": { "summary": "会员开通", "description": "基于已支付订单为客户端用户开通会员资格，并自动同步会员用户记录和订单状态。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "客户端登录令牌，格式为 Bearer TOKEN", "example": "Bearer {token}" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "memberType": { "type": "string", "description": "string｜必填，会员类型编码或名称，如 VIP" }, "orderNo": { "type": "string", "description": "string｜必填，已支付订单号" } }, "required": [ "memberType", "orderNo" ] } } } }, "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } }, "/openapi/memberships/register": { "post": { "summary": "会员注册", "description": "根据注册令牌中的信息自动落地企业或散客账号。如果启用了站点分配，会为用户创建个人站点和独立数据库，并自动创建超级管理员角色。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "注册令牌，服务端提前生成，格式为 Bearer TOKEN", "example": "Bearer {token}" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "所属站点标识，用户将注册到该站点" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } }, "/openapi/memberships/login": { "post": { "summary": "会员登录", "description": "同时支持企业账号与散客账号的登录校验，并返回加密的登录令牌。如果用户有多个可用站点，会返回站点信息。散客账号登录时必须包含同意协议字段。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "登录令牌，包含手机号、密码和同意协议信息（散客账号必填），格式为 Bearer TOKEN。令牌 payload 应包含：phone（手机号）、password（密码）、agreeTerms（同意协议，散客账号必填且必须为 true）", "example": "Bearer {token}" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码。用于指定当前登录的业务系统（例如 AUTH_MANAGEMENT、CONTENT_MANAGEMENT）。当系统不支持时将返回“登录用户不支持当前系统，可联系管理员处理”。" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } }, "/openapi/memberships/login/verify": { "post": { "summary": "登录令牌校验", "description": "对登录接口返回的访问令牌进行有效性校验，确认令牌是否过期、账号状态及黑名单状态。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "登录接口返回的访问令牌，格式为 Bearer TOKEN", "example": "Bearer {token}" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码。用于指定当前登录的业务系统（例如 AUTH_MANAGEMENT、CONTENT_MANAGEMENT）。当系统不支持时将返回“登录用户不支持当前系统，可联系管理员处理”。" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "登录令牌校验成功", "data": { "phone": "13800138000", "id": "USER000001", "_id": "MNFIOHH6QOA3kg0z" } }, "failure": { "code": "1300", "message": "登录令牌无效或已过期", "data": null } } } } } } } }, "/openapi/permissions/resource-check": { "post": { "summary": "资源权限校验", "description": "基于登录令牌校验指定系统下用户是否拥有访问某接口所需的资源与权限。支持通过 X-Site header 切换站点。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "登录接口返回的访问令牌，格式为 Bearer TOKEN", "example": "Bearer {token}" }, { "name": "X-Site", "in": "header", "required": false, "schema": { "type": "string" }, "description": "站点标识。用于切换站点和对应的数据库上下文。如果用户有多个可用站点，可通过此 header 切换。" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "systemCode": { "type": "string", "description": "string｜必填，目标系统编码" }, "apiName": { "type": "string", "description": "string｜必填，接口标识（可使用资源 code、name、title 或 URL）" }, "requiredPermissions": { "type": "string", "description": "string[]｜选填，需要同时具备的权限编码数组" } }, "required": [ "systemCode", "apiName" ] } } } }, "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } }, "/openapi/permissions/check": { "post": { "summary": "账户权限校验", "description": "根据访问令牌校验账户在指定系统下拥有的资源与权限。资源列表以树状结构返回，方便前端渲染菜单等场景。支持通过 X-Site header 切换站点。", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "访问令牌，支持系统用户与客户端用户，格式为 Bearer TOKEN", "example": "Bearer {token}" }, { "name": "X-Site", "in": "header", "required": false, "schema": { "type": "string" }, "description": "站点标识。用于切换站点和对应的数据库上下文。如果用户有多个可用站点，可通过此 header 切换。" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "systemCode": { "type": "string", "description": "string｜必填，要校验的系统编码" } }, "required": [ "systemCode" ] } } } }, "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } }, "/openapi/stateless-members/activate": { "post": { "summary": "激活无状态会员", "description": "激活无状态会员，通过X-Member-Key header中的混合JWT解密得到密钥，校验会员有效性后生成新的密钥令牌返回。", "parameters": [ { "name": "X-Member-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "会员密钥令牌，通过混合JWT加密" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码，用于判断会员类型是否支持当前系统" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } }, "/openapi/stateless-members/check": { "post": { "summary": "检查无状态会员有效性", "description": "检查无状态会员是否还有效，通过X-Member-Key header中的混合JWT解密得到密钥，校验会员状态、过期时间、系统支持等，返回剩余天数。", "parameters": [ { "name": "X-Member-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "会员密钥令牌，通过混合JWT加密" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码，用于判断会员类型是否支持当前系统" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } }, "/openapi/stateless-members/functionCheck": { "post": { "summary": "检查无状态会员功能有效性", "description": "在检查无状态会员有效性的基础上，额外通过X-Function header检查会员功能模块中是否有该功能。", "parameters": [ { "name": "X-Member-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "会员密钥令牌，通过混合JWT加密" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码，用于判断会员类型是否支持当前系统" }, { "name": "X-Function", "in": "header", "required": true, "schema": { "type": "string" }, "description": "功能代码，用于检查会员功能模块中是否有该功能" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } }, "/openapi/stateless-members/valid-check": { "post": { "summary": "无状态会员有效性校验（场景A）", "description": "场景A：仅校验无状态会员是否有效（未过期），不校验会员类型与系统的支持关系。适用于第三方只需确认会员是否开通且未到期的简单场景。", "parameters": [ { "name": "X-Member-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "会员密钥令牌（混合JWT加密，payload.data = secretKey）" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（用于路由到正确数据库，本接口不校验系统-会员类型兼容性）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "code": "0000", "message": "成功" } } } } } } }, "/openapi/stateless-members/limitCheck": { "post": { "summary": "无状态会员限额校验（场景D）", "description": "场景D：在场景C（功能模块校验）的基础上，进一步校验当前功能模块的使用量是否已达到配置的上限（limitValue）。适用于有次数或存储上限控制的业务场景。", "parameters": [ { "name": "X-Member-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "会员密钥令牌（混合JWT加密）" }, { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码" }, { "name": "X-Function", "in": "header", "required": true, "schema": { "type": "string" }, "description": "功能模块代码（moduleCode），如 VIDEO_DOWNLOAD" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currentCount": { "type": "number", "description": "number｜必填，当前已使用次数/数量（由第三方系统维护），如 8" } }, "required": [ "currentCount" ] } } } }, "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "code": "0000", "message": "成功" } } } } } } }, "/openapi/users/list": { "get": { "summary": "用户管理 - 分页列表查询", "description": "分页查询用户管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/users/list/simple": { "get": { "summary": "用户管理 - 简单列表查询", "description": "无分页返回用户管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/client-users/list": { "get": { "summary": "客户端用户管理 - 分页列表查询", "description": "分页查询客户端用户管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/client-users/list/simple": { "get": { "summary": "客户端用户管理 - 简单列表查询", "description": "无分页返回客户端用户管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/organizations/list": { "get": { "summary": "组织管理 - 分页列表查询", "description": "分页查询组织管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/organizations/list/simple": { "get": { "summary": "组织管理 - 简单列表查询", "description": "无分页返回组织管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/departments/list": { "get": { "summary": "部门管理 - 分页列表查询", "description": "分页查询部门管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/departments/list/simple": { "get": { "summary": "部门管理 - 简单列表查询", "description": "无分页返回部门管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/positions/list": { "get": { "summary": "岗位管理 - 分页列表查询", "description": "分页查询岗位管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/positions/list/simple": { "get": { "summary": "岗位管理 - 简单列表查询", "description": "无分页返回岗位管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/staff/list": { "get": { "summary": "职员管理 - 分页列表查询", "description": "分页查询职员管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/staff/list/simple": { "get": { "summary": "职员管理 - 简单列表查询", "description": "无分页返回职员管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/roles/list": { "get": { "summary": "角色管理 - 分页列表查询", "description": "分页查询角色管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/roles/list/simple": { "get": { "summary": "角色管理 - 简单列表查询", "description": "无分页返回角色管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/resources/list": { "get": { "summary": "资源管理 - 分页列表查询", "description": "分页查询资源管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/resources/list/simple": { "get": { "summary": "资源管理 - 简单列表查询", "description": "无分页返回资源管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/permissions/list": { "get": { "summary": "权限管理 - 分页列表查询", "description": "分页查询权限管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/permissions/list/simple": { "get": { "summary": "权限管理 - 简单列表查询", "description": "无分页返回权限管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/customers/list": { "get": { "summary": "客户管理 - 分页列表查询", "description": "分页查询客户管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/customers/list/simple": { "get": { "summary": "客户管理 - 简单列表查询", "description": "无分页返回客户管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/orders/list": { "get": { "summary": "订单管理 - 分页列表查询", "description": "分页查询订单管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/orders/list/simple": { "get": { "summary": "订单管理 - 简单列表查询", "description": "无分页返回订单管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/members/list": { "get": { "summary": "会员管理 - 分页列表查询", "description": "分页查询会员管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/members/list/simple": { "get": { "summary": "会员管理 - 简单列表查询", "description": "无分页返回会员管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/stateless-members/list": { "get": { "summary": "无状态会员管理 - 分页列表查询", "description": "分页查询无状态会员管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/stateless-members/list/simple": { "get": { "summary": "无状态会员管理 - 简单列表查询", "description": "无分页返回无状态会员管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/member-users/list": { "get": { "summary": "会员用户管理 - 分页列表查询", "description": "分页查询会员用户管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/member-users/list/simple": { "get": { "summary": "会员用户管理 - 简单列表查询", "description": "无分页返回会员用户管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/member-functions/list": { "get": { "summary": "会员功能管理 - 分页列表查询", "description": "分页查询会员功能管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/member-functions/list/simple": { "get": { "summary": "会员功能管理 - 简单列表查询", "description": "无分页返回会员功能管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/member-types/list": { "get": { "summary": "会员类型管理 - 分页列表查询", "description": "分页查询会员类型管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/member-types/list/simple": { "get": { "summary": "会员类型管理 - 简单列表查询", "description": "无分页返回会员类型管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/member-function-limits/list": { "get": { "summary": "会员功能限制管理 - 分页列表查询", "description": "分页查询会员功能限制管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/member-function-limits/list/simple": { "get": { "summary": "会员功能限制管理 - 简单列表查询", "description": "无分页返回会员功能限制管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/whitelists/list": { "get": { "summary": "白名单管理 - 分页列表查询", "description": "分页查询白名单管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/whitelists/list/simple": { "get": { "summary": "白名单管理 - 简单列表查询", "description": "无分页返回白名单管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/blacklists/list": { "get": { "summary": "黑名单管理 - 分页列表查询", "description": "分页查询黑名单管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/blacklists/list/simple": { "get": { "summary": "黑名单管理 - 简单列表查询", "description": "无分页返回黑名单管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/support-systems/list": { "get": { "summary": "系统管理 - 分页列表查询", "description": "分页查询系统管理状态有效的列表数据，支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } }, "/openapi/support-systems/list/simple": { "get": { "summary": "系统管理 - 简单列表查询", "description": "无分页返回系统管理前100条状态有效数据的列表，支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "名称（模糊搜索）" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "编码（模糊搜索）" }, { "name": "sortBy", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序字段，默认createTime" }, { "name": "sortOrder", "in": "query", "required": false, "schema": { "type": "string" }, "description": "排序方向：asc-升序，desc-降序，默认desc" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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" } ] } } } } } } } } }, "/openapi/sites/list": { "get": { "summary": "站点数据 - 列表查询", "description": "返回用户名和对应站点key的列表，用于查看。必须提供有效的X-Site和X-System-Code header。", "parameters": [ { "name": "X-Site", "in": "header", "required": true, "schema": { "type": "string" }, "description": "站点标识（必填）" }, { "name": "X-System-Code", "in": "header", "required": true, "schema": { "type": "string" }, "description": "系统编码（必填）" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "站点名称（模糊搜索）" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "查询成功", "data": { "list": [ { "userName": "张三", "siteKey": "47F38C4F-3437-4108-96EE-0621B30EF2B9-7B75868C742688BD3", "siteName": "个人站点" } ] } } } } } } } } } } }