← 返回首页

API模块详情

当前查看模块:openapi

公共请求头(所有接口适用)

参数名 必填 类型 示例 说明
Authorization string Bearer <JWT token> 用户登录后的 JWT 令牌。若已登录可直接使用,无需传 X-Client。。认证 Token,请在请求头中携带,推荐格式:Bearer {token}
X-Client string <client key token> 客户端密钥。当未携带或无法使用 Authorization 时必填,用于密钥认证。线上文档: http://localhost:5601/docs
X-Site string <site key> 站点标识(必填)。用于切换站点和对应的数据库上下文。所有 OpenAPI 接口必须提供有效的 X-Site header。
X-Scope-Key string eyJhbGciOiJIUzI1NiIs... Scope 分区混合 JWT(仅 OpenAPI 业务数据 list/statistics/写入接口必填,与登录 token 无关)。payload 含 scopeKey(UUID,来自登录响应 defaultScopeKey) 与 timestamp(毫秒);|服务器时间-timestamp|须≤5秒。客户端用 G_S_T 自行 generateMixedJWT 生成,勿传裸 UUID。
X-System-Code string AUTH_MANAGEMENT 系统编码(必填,鉴权用)。校验调用方声明的业务系统是否属于当前 X-Site 站点下已启用的 securitySystems 白名单;不用于覆盖请求体中的 systemId 等业务字段。不在白名单时返回「不支持当前系统,可联系管理员处理」。

API响应码列表

共 55 个响应码
API响应码说明。所有接口统一返回HTTP 200状态码,业务状态通过响应体中的code字段表示。 点击展开

成功响应码 (1个)

参数名 必填 类型 示例 说明
0000 string 操作成功 请求处理成功,这是所有成功响应的标准代码

错误响应码 (54个)

参数名 必填 类型 示例 说明
1001 string 缺少令牌 请求中缺少必要的令牌(访问令牌、登录令牌、注册令牌等)
1002 string 令牌无效或已过期 提供的令牌格式错误、无法解析、已过期或信息不完整
1003 string 会员不存在 指定的会员记录在系统中不存在
1004 string 会员状态无效 会员状态不是有效状态(非启用状态)
1005 string 会员已过期 会员的有效期已过
1006 string 系统未开放或已停用 请求的系统代码对应的系统未启用、不存在或已被停用
1007 string 会员类型未授权当前系统 当前会员类型未配置访问该系统的权限,或会员码不支持当前系统
1008 string 系统模块未开放访问 请求的系统模块未启用或不存在
1009 string 会员未开通该功能模块 会员未开通请求的功能模块
1010 string 当前模块的使用已达到上限 模块使用次数已达到配置的上限值
1103 string 账号已被加入黑名单 账号已被加入黑名单,无法执行操作或登录
1104 string 会员类型不存在或已停用 指定的会员类型不存在或已被停用
1105 string 订单不存在 指定的订单记录在系统中不存在
1106 string 订单手机号与当前账号不匹配 订单关联的手机号与当前登录账号的手机号不一致
1107 string 订单尚未支付或已失效 订单状态不是已支付或已完成状态
1108 string 订单类型与会员类型不匹配 订单的会员类型与请求的会员类型不一致
1109 string 管理员角色未配置 系统中未找到管理员角色配置
1201 string 密码需包含字母和数字,且不少于6位 密码不符合要求:必须包含字母和数字,且长度不少于6位(适用于注册和登录)
1202 string 手机号已注册系统用户 该手机号已被注册为系统用户
1203 string 公司信用代码已注册 该公司信用代码已被注册
1204 string 手机号已注册客户端用户 该手机号已被注册为客户端用户
1205 string 新密码与确认密码不一致 修改密码时新密码与确认密码字段不一致
1210 string 站点标识生成失败,请稍后重试 生成站点标识时发生错误
1211 string 拒绝无效访问 站点标识无效或访问被拒绝
1212 string 注册申请已提交,待审核 注册信息已入库且账号处于禁用状态,需管理端审核通过后方可启用;在 X-Individualism=true(开独立站点)或企业注册(系统用户)时返回;下游应视为待审核而非注册成功
1221 string scope key 无效或已禁用 X-Scope-Key 不存在、已禁用或不属于当前 X-Site 站点
1220 string 缺少 scope key OpenAPI 业务数据接口未提供 X-Scope-Key header
1303 string 请同意隐私等协议 散客账号登录时必须同意隐私协议
1304 string 账号或密码错误 登录时提供的账号或密码不正确
1305 string 旧密码错误 修改密码时提供的旧密码不正确
1306 string 用户未启用或已过期 用户状态不是启用状态,或用户有效期已过(适用于系统用户和客户端用户)
1401 string 用户不存在 指定的用户记录在系统中不存在(适用于系统用户和客户端用户)
1403 string 不支持当前系统, 可联系管理员处理 当前账号不支持访问该系统,需要联系管理员处理
1500 string 接口标识不能为空 / 缺少会员密钥 / 会员密钥无效 请求中缺少会员密钥,或会员密钥格式错误、无法解析
1501 string 接口未授权或未在系统中配置 / 激活已超时,请重新绑定激活 接口未授权或未在系统中配置,或激活操作已超时需要重新绑定
1502 string 缺少必要权限 账号缺少访问资源所需的权限
1504 string 您绑定的会员码无效 绑定的会员码不存在、状态无效、会员类型无效或已过期
1505 string 传入的会员需要重新绑定 会员密钥已过期,需要重新绑定激活
1508 string 当前会员不支持当前功能 会员未开通请求的功能模块
1509 string 缺少功能代码 请求中缺少必要的功能代码参数
1510 string 无状态会员不存在 购买/占用时指定的无状态会员 id 或编码不存在
1511 string 无状态会员未启用,不可购买 无状态会员 status 不为有效(1),不可标记为已售出
1512 string 该无状态会员已售出,不可重复购买 无状态会员 saleStatus 已为已售(1),不可二次购买或占用
1999 string 权限校验失败 权限校验过程中发生未预期的错误
400 string 请求参数错误 / 参数验证失败 请求参数格式错误或验证失败
401 string 未授权访问 / 令牌无效 / 令牌已过期 / 登录失败,用户名或密码错误 未授权访问,令牌无效或已过期,或登录凭据错误
403 string 禁止访问 账号没有权限访问该资源
404 string 资源不存在 请求的资源在系统中不存在
405 string 此接口仅支持 POST 方法,请使用 POST 请求 请求方法不正确,该接口仅支持POST方法
409 string 资源冲突 / 数据已存在 创建的资源已存在,或数据冲突
429 string 请求过于频繁,请稍后再试 请求频率超过限制,需要稍后重试
500 string 操作失败 / 服务器内部错误 / 数据库操作失败 服务器内部错误,操作失败或数据库操作异常
1222 string scope key 令牌时间戳无效 X-Scope-Key JWT 缺少或无法解析 timestamp 字段
1223 string scope key 令牌已失效,请重新生成(请求时间与服务器时间差超过5秒) 防重放:JWT 内 timestamp 与服务器时间差超过 5 秒

OpenAPI 接口

模块标识: openapi | 接口数量: 76

POST 有状态会员有效性校验(场景A) /openapi/memberships/valid-check

查看详情
场景A:校验已登录用户的会员是否有效(未过期),不校验系统支持。适用于第三方已持有用户登录令牌,只需确认该用户是否有效会员的场景。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 用户登录令牌,格式 Bearer TOKEN(通过 /memberships/login 获取)
X-Site string - 站点标识
X-System-Code string - 系统编码(用于路由到正确数据库)
响应示例
校验通过:
{
  "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
}
注意事项
  • 系统自动取该用户最新一条未过期的 memberUser 记录
  • 场景B(验系统支持)请使用 /memberships/check
  • 场景C(验功能模块)请使用 /memberships/functionCheck
  • 场景D(验功能限额)请使用 /memberships/limitCheck

POST 有状态会员系统支持校验(场景B) /openapi/memberships/check

查看详情
场景B:校验已登录用户的会员有效性,并校验该用户的会员类型是否已配置支持指定系统。适用于系统级访问控制,如黄金会员才能访问系统B。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 用户登录令牌,格式 Bearer TOKEN
X-Site string - 站点标识
X-System-Code string - 系统编码,同时作为校验目标(会员类型是否支持该系统)
响应示例
校验通过:
{
  "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
}
注意事项
  • 需在管理后台「会员功能管理」中为该会员类型配置支持该系统,否则会返回1007
  • 系统校验基于 memberFunctions 表(memberTypeId + systemId + status=1)

POST 有状态会员功能模块校验(场景C) /openapi/memberships/functionCheck

查看详情
场景C:在场景B基础上,进一步校验该用户的会员类型在指定系统下是否开通了特定功能模块。适用于菜单/功能级别的精细控制。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 用户登录令牌,格式 Bearer TOKEN
X-Site string - 站点标识
X-System-Code string - 系统编码
X-Function string - 功能模块代码(moduleCode),如 VIDEO_DOWNLOAD
响应示例
校验通过:
{
  "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
}
注意事项
  • 需在管理后台「会员功能模块」中为该会员类型的系统功能配置对应模块
  • X-Function 传入 securityModules.code 或自定义 moduleCode(memberFunctionModules 中配置的模块编码)

POST 有状态会员限额校验(场景D) /openapi/memberships/limitCheck

查看详情
场景D:在场景C基础上,校验指定系统模块(X-Function → securityModules)的使用量是否已达 memberFunctionLimits 配置上限。不查询用户 RBAC 资源。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 用户登录令牌,格式 Bearer TOKEN
X-Site string - 站点标识
X-System-Code string - 系统编码
X-Function string - 功能模块代码

请求体

{
  "currentCount": "number|必填,当前已使用次数/数量(由第三方系统维护)"
}

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

响应示例
校验通过(有限额):
{
  "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
  }
}
注意事项
  • 仅校验系统模块(securityModules)及 memberFunctionLimits,不查询用户 RBAC 资源
  • limit 为 null 表示未配置限额,不限次数
  • currentCount 由第三方系统传入,本系统不持久化使用记录
  • 限额配置在管理后台「会员功能限制」中设置(memberFunctionLimits 表)

POST 无状态会员资源校验(场景A) /openapi/stateless-members/resources/valid-check

查看详情
返回与 /openapi/permissions/check 一致的资源结构,并叠加无状态会员有效性约束(仅校验会员有效)。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 账号登录令牌,格式 Bearer TOKEN
X-Member-Key string - 会员密钥令牌
X-Site string - 站点标识
响应示例
{
  "success": {
    "code": "0000",
    "message": "校验通过",
    "data": {
      "user": {
        "id": "u001",
        "code": "CU000001",
        "username": "张三",
        "type": "clientUser"
      },
      "resources": [],
      "resourcesByType": {},
      "resourceUrls": []
    }
  }
}
注意事项
  • 响应结构与 /openapi/permissions/check 一致
  • 当会员约束不满足时,返回空资源(resources=[])

POST 无状态会员资源校验(场景B) /openapi/stateless-members/resources/check

查看详情
返回与 /openapi/permissions/check 一致的资源结构,并叠加无状态会员有效性+系统支持约束。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 账号登录令牌,格式 Bearer TOKEN
X-Member-Key string - 会员密钥令牌
X-System-Code string - 系统编码
X-Site string - 站点标识
响应示例
{
  "success": {
    "code": "0000",
    "message": "校验通过",
    "data": {
      "system": {
        "code": "AUTH_MANAGEMENT",
        "name": "权限管理系统"
      },
      "resources": [],
      "resourcesByType": {},
      "resourceUrls": []
    }
  }
}
注意事项
  • 系统级校验与 /openapi/stateless-members/check 参数要求一致
  • 会员不支持系统时,资源返回为空

POST 无状态会员资源校验(场景C) /openapi/stateless-members/resources/functionCheck

查看详情
返回与 /openapi/permissions/check 一致的资源结构,并叠加无状态会员有效性+系统约束。系统会自动解析该会员在当前系统下已授权的模块,并返回对应模块资源。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 账号登录令牌,格式 Bearer TOKEN
X-Member-Key string - 会员密钥令牌
X-System-Code string - 系统编码
X-Site string - 站点标识
响应示例
{
  "success": {
    "code": "0000",
    "message": "校验通过",
    "data": {
      "resources": [],
      "resourcesByType": {},
      "resourceUrls": []
    }
  }
}

POST 无状态会员资源校验(场景D) /openapi/stateless-members/resources/limitCheck

查看详情
返回与 /openapi/permissions/check 一致的资源结构,并叠加无状态会员有效性+系统+限额约束。系统会自动按会员在当前系统下已授权模块过滤资源,并对这些模块应用限额筛选。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 账号登录令牌,格式 Bearer TOKEN
X-Member-Key string - 会员密钥令牌
X-System-Code string - 系统编码
X-Site string - 站点标识

请求体

{
  "currentCount": "number|必填,当前已使用次数/数量"
}

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

响应示例
{
  "success": {
    "code": "0000",
    "message": "校验通过",
    "data": {
      "resources": [],
      "resourcesByType": {},
      "resourceUrls": []
    }
  }
}

POST 有状态会员资源校验(场景A) /openapi/memberships/resources/valid-check

查看详情
返回与 /openapi/permissions/check 一致的资源结构,并叠加有状态会员有效性约束。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 用户登录令牌,格式 Bearer TOKEN
X-Site string - 站点标识
响应示例
{
  "success": {
    "code": "0000",
    "message": "校验通过",
    "data": {
      "resources": [],
      "resourcesByType": {},
      "resourceUrls": []
    }
  }
}

POST 有状态会员资源校验(场景B) /openapi/memberships/resources/check

查看详情
返回与 /openapi/permissions/check 一致的资源结构,并叠加有状态会员有效性+系统支持约束。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 用户登录令牌,格式 Bearer TOKEN
X-System-Code string - 系统编码
X-Site string - 站点标识
响应示例
{
  "success": {
    "code": "0000",
    "message": "校验通过",
    "data": {
      "resources": [],
      "resourcesByType": {},
      "resourceUrls": []
    }
  }
}

POST 有状态会员资源校验(场景C) /openapi/memberships/resources/functionCheck

查看详情
返回与 /openapi/permissions/check 一致的资源结构,并叠加有状态会员有效性+系统约束。系统会自动解析该会员在当前系统下已授权的模块,并返回对应模块资源。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 用户登录令牌,格式 Bearer TOKEN
X-System-Code string - 系统编码
X-Site string - 站点标识
响应示例
{
  "success": {
    "code": "0000",
    "message": "校验通过",
    "data": {
      "resources": [],
      "resourcesByType": {},
      "resourceUrls": []
    }
  }
}

POST 有状态会员资源校验(场景D) /openapi/memberships/resources/limitCheck

查看详情
返回与 /openapi/permissions/check 一致的资源结构。流程:① 取用户 RBAC 资源并按系统过滤;② 按会员已授权系统模块(memberFunctionModules.moduleId → 与 resource.moduleId 匹配)筛选;③ 对仍关联到已超限模块(memberFunctionLimits)的资源剔除。不通过 moduleId 查 resources 主键。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 用户登录令牌,格式 Bearer TOKEN
X-System-Code string - 系统编码
X-Site string - 站点标识

请求体

{
  "currentCount": "number|必填,当前已使用次数/数量"
}

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

响应示例
{
  "success": {
    "code": "0000",
    "message": "校验通过",
    "data": {
      "resources": [],
      "resourcesByType": {},
      "resourceUrls": []
    }
  }
}
注意事项
  • resource.moduleId 应指向 securityModules(在资源管理中设置),与 memberFunctionModules.moduleId 同一套模块体系
  • currentCount 与 memberFunctionLimits 按 moduleId 比对;超限时剔除该模块下的资源
  • 会员条件不满足时返回空资源,而不是抛错

POST 无状态会员+用户资源合并(场景A) /openapi/stateless-members/resources/combined-valid-check

查看详情
返回用户 RBAC 绑定资源与无状态会员授权资源的并集,响应结构与 /openapi/permissions/check 一致。先校验无状态会员有效性,再合并用户角色资源;会员约束不满足时仍返回用户自身资源。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 账号登录令牌,格式 Bearer TOKEN
X-Member-Key string - 会员密钥令牌
X-Site string - 站点标识
响应示例
{
  "success": {
    "code": "0000",
    "message": "校验通过",
    "data": {
      "user": {
        "id": "u001",
        "code": "CU000001",
        "username": "张三",
        "type": "clientUser"
      },
      "resources": [],
      "resourcesByType": {},
      "resourceUrls": []
    }
  }
}
注意事项
  • 与 /openapi/stateless-members/resources/valid-check 的区别:本接口始终包含用户 RBAC 资源,并叠加会员模块资源
  • 会员约束失败时不抛错,仍返回用户 RBAC 资源
  • 相同资源按 _id/id 去重

POST 无状态会员+用户资源合并(场景B) /openapi/stateless-members/resources/combined-check

查看详情
返回用户 RBAC 资源(按系统过滤)与无状态会员在当前系统下授权模块资源的并集。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 账号登录令牌,格式 Bearer TOKEN
X-Member-Key string - 会员密钥令牌
X-System-Code string - 系统编码
X-Site string - 站点标识
响应示例
{
  "success": {
    "code": "0000",
    "message": "校验通过",
    "data": {
      "resources": [],
      "resourcesByType": {},
      "resourceUrls": []
    }
  }
}
注意事项
  • 用户 RBAC 资源与会员资源均按 X-System-Code 过滤
  • 会员不支持当前系统时仍返回用户 RBAC 资源

POST 无状态会员+用户资源合并(场景C) /openapi/stateless-members/resources/combined-functionCheck

查看详情
与 combined-check 相同:返回用户 RBAC 资源与无状态会员在当前系统下已授权模块资源的并集。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 账号登录令牌,格式 Bearer TOKEN
X-Member-Key string - 会员密钥令牌
X-System-Code string - 系统编码
X-Site string - 站点标识
响应示例
{
  "success": {
    "code": "0000",
    "message": "校验通过",
    "data": {
      "resources": [],
      "resourcesByType": {},
      "resourceUrls": []
    }
  }
}

POST 无状态会员+用户资源合并(场景D) /openapi/stateless-members/resources/combined-limitCheck

查看详情
返回用户 RBAC 资源与无状态会员资源的并集;会员资源部分按 memberFunctionLimits 做限额筛选,用户 RBAC 资源不受限额影响。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 账号登录令牌,格式 Bearer TOKEN
X-Member-Key string - 会员密钥令牌
X-System-Code string - 系统编码
X-Site string - 站点标识

请求体

{
  "currentCount": "number|必填,当前已使用次数/数量"
}

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

响应示例
{
  "success": {
    "code": "0000",
    "message": "校验通过",
    "data": {
      "resources": [],
      "resourcesByType": {},
      "resourceUrls": []
    }
  }
}
注意事项
  • 限额仅作用于会员模块资源,用户 RBAC 资源始终保留
  • 会员约束失败时仍返回用户 RBAC 资源

POST 有状态会员+用户资源合并(场景A) /openapi/memberships/resources/combined-valid-check

查看详情
返回用户 RBAC 绑定资源与有状态会员授权模块资源的并集。先校验会员有效性,再合并用户角色资源;会员无效时仍返回用户自身资源。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 用户登录令牌,格式 Bearer TOKEN
X-Site string - 站点标识
响应示例
{
  "success": {
    "code": "0000",
    "message": "校验通过",
    "data": {
      "resources": [],
      "resourcesByType": {},
      "resourceUrls": []
    }
  }
}
注意事项
  • 与 /openapi/memberships/resources/valid-check 的区别:本接口始终包含用户 RBAC 资源
  • 相同资源按 _id/id 去重

POST 有状态会员+用户资源合并(场景B) /openapi/memberships/resources/combined-check

查看详情
返回用户 RBAC 资源(按系统过滤)与有状态会员在当前系统下授权模块资源的并集。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 用户登录令牌,格式 Bearer TOKEN
X-System-Code string - 系统编码
X-Site string - 站点标识
响应示例
{
  "success": {
    "code": "0000",
    "message": "校验通过",
    "data": {
      "resources": [],
      "resourcesByType": {},
      "resourceUrls": []
    }
  }
}

POST 有状态会员+用户资源合并(场景C) /openapi/memberships/resources/combined-functionCheck

查看详情
与 combined-check 相同:返回用户 RBAC 资源与有状态会员在当前系统下已授权模块资源的并集。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 用户登录令牌,格式 Bearer TOKEN
X-System-Code string - 系统编码
X-Site string - 站点标识
响应示例
{
  "success": {
    "code": "0000",
    "message": "校验通过",
    "data": {
      "resources": [],
      "resourcesByType": {},
      "resourceUrls": []
    }
  }
}

POST 有状态会员+用户资源合并(场景D) /openapi/memberships/resources/combined-limitCheck

查看详情
返回用户 RBAC 资源与有状态会员资源的并集;会员资源部分按 memberFunctionLimits 做限额筛选,用户 RBAC 资源不受限额影响。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 用户登录令牌,格式 Bearer TOKEN
X-System-Code string - 系统编码
X-Site string - 站点标识

请求体

{
  "currentCount": "number|必填,当前已使用次数/数量"
}

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

响应示例
{
  "success": {
    "code": "0000",
    "message": "校验通过",
    "data": {
      "resources": [],
      "resourcesByType": {},
      "resourceUrls": []
    }
  }
}
注意事项
  • 限额仅作用于会员模块资源,用户 RBAC 资源始终保留
  • 会员无效或不支持当前系统时仍返回用户 RBAC 资源

POST 会员开通 /openapi/memberships/activate

查看详情
基于已支付订单为客户端用户开通会员资格,并自动同步会员用户记录和订单状态。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 客户端登录令牌,格式为 Bearer TOKEN

请求体

{
  "memberType": "string|必填,会员类型编码或名称,如 VIP",
  "orderNo": "string|必填,已支付订单号"
}

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

响应示例
{
  "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
  }
}
注意事项
  • 该接口会校验黑名单、订单手机号、订单状态与会员类型一致性。
  • 响应 Header X-OpenAPI-Result 存放加密结果用于客户端追踪。

POST 会员注册 /openapi/memberships/register

查看详情
根据注册令牌创建企业或散客账号。注册令牌中同时填写 companyName 与 companyCreditCode 时创建系统用户(users)及组织;否则创建客户端用户(clientUsers)。当 X-Individualism 为 true(开独立站点)或为企业注册(系统用户)时需管理端审核(返回 1212);仅散客且不开独立站点时自动放行(返回 0000)。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 注册令牌,服务端提前生成,格式为 Bearer TOKEN
X-Site string - 所属站点标识,用户将注册到该站点
X-Individualism boolean - 是否需开通独立站点(记录在审核单 individualism 字段,审核通过后生效),默认 true。传 false、0、no、off 表示审核通过后也不创建用户自有独立站点。
响应示例
{
  "success": {
    "code": "0000",
    "message": "会员注册成功",
    "data": {
      "accountType": "client",
      "clientUser": {
        "code": "CU000001",
        "name": "散客用户",
        "phone": "13800138001",
        "status": 1,
        "individualism": false
      },
      "site": {
        "key": "A1B2C3D4-xxxx",
        "name": "个人站点"
      }
    }
  },
  "pendingAudit": {
    "code": "1212",
    "message": "注册申请已提交,待审核",
    "data": {
      "accountType": "company",
      "user": {
        "code": "USER000001",
        "name": "企业管理员",
        "phone": "13800138000",
        "status": 0,
        "individualism": false
      },
      "organization": {
        "code": "ORG000001",
        "name": "靖苒数字"
      },
      "auditRecord": {
        "id": 1,
        "code": "AR0001",
        "status": 0,
        "auditType": "REGISTER_USER",
        "individualism": true
      }
    }
  },
  "failure": {
    "code": "1203",
    "message": "公司信用代码已注册",
    "data": null
  }
}
注意事项
  • 账号类型:注册令牌 payload 中 companyName 与 companyCreditCode 均非空 → 系统用户(users)+ 组织;否则 → 客户端用户(clientUsers)。
  • 审核条件(满足任一即走审核,返回 1212、status=0):① X-Individualism=true(开独立站点);② 企业注册(系统用户)。
  • 自动放行(返回 0000、status=1):散客注册且 X-Individualism=false,仅绑定 X-Site,不开独立站点。
  • 审核通过后:按 auditRecord.individualism 决定是否开通独立站点;审核类型 REGISTER_USER / REGISTER_CLIENT 对应系统用户与客户端用户。
  • 密码要求同时包含字母和数字,长度不少于 6 位。

POST 会员登录 /openapi/memberships/login

查看详情
同时支持企业账号与散客账号的登录校验,并返回加密的登录令牌。成功时 data 还包含 scopeKeys(可用 scope 列表)与 defaultScopeKey(默认数据分区 UUID,有组织时为组织 scope)。如果用户有多个可用站点,会返回站点信息。散客账号登录时必须包含同意协议字段。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 登录令牌,包含手机号、密码和同意协议信息(散客账号必填),格式为 Bearer TOKEN。令牌 payload 应包含:phone(手机号)、password(密码)、agreeTerms(同意协议,散客账号必填且必须为 true)
X-System-Code string - 系统编码。用于指定当前登录的业务系统(例如 AUTH_MANAGEMENT、CONTENT_MANAGEMENT)。当系统不支持时将返回“登录用户不支持当前系统,可联系管理员处理”。
响应示例
有个人站点:
{
  "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"
    },
    "scopeKeys": [
      {
        "key": "550e8400-e29b-41d4-a716-446655440001",
        "type": "personal",
        "label": "个人"
      },
      {
        "key": "550e8400-e29b-41d4-a716-446655440002",
        "type": "organization",
        "organizationId": 1,
        "label": "示例公司"
      }
    ],
    "defaultScopeKey": "550e8400-e29b-41d4-a716-446655440002"
  }
}
无个人站点:
{
  "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,
    "scopeKeys": [
      {
        "key": "550e8400-e29b-41d4-a716-446655440001",
        "type": "personal",
        "label": "个人"
      }
    ],
    "defaultScopeKey": "550e8400-e29b-41d4-a716-446655440001"
  }
}
注意事项
  • 优先尝试企业账号登录,失败后自动回退到散客账号校验。
  • 散客账号登录时,登录令牌的 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 切换站点,切换后使用对应站点的数据库。
  • 登录成功响应 body 包含 scopeKeys 与 defaultScopeKey,供外部业务系统绑定数据分区

POST 登录令牌校验 /openapi/memberships/login/verify

查看详情
对登录接口返回的访问令牌进行有效性校验,确认令牌是否过期、账号状态及黑名单状态。校验成功时 data 同时返回 scopeKeys 与 defaultScopeKey,与登录接口一致,便于外部系统在仅持有令牌时获取数据分区信息。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 登录接口返回的访问令牌,格式为 Bearer TOKEN
X-System-Code string - 系统编码。用于指定当前登录的业务系统(例如 AUTH_MANAGEMENT、CONTENT_MANAGEMENT)。当系统不支持时将返回“登录用户不支持当前系统,可联系管理员处理”。
响应示例
{
  "success": {
    "code": "0000",
    "message": "登录令牌校验成功",
    "data": {
      "phone": "13800138000",
      "id": "USER000001",
      "_id": "MNFIOHH6QOA3kg0z",
      "scopeKeys": [
        {
          "key": "550e8400-e29b-41d4-a716-446655440001",
          "type": "personal",
          "label": "个人"
        },
        {
          "key": "550e8400-e29b-41d4-a716-446655440002",
          "type": "organization",
          "organizationId": 1,
          "label": "示例公司"
        }
      ],
      "defaultScopeKey": "550e8400-e29b-41d4-a716-446655440002"
    }
  },
  "failure": {
    "code": "1300",
    "message": "登录令牌无效或已过期",
    "data": null
  }
}
注意事项
  • 当令牌失效、对应账号被禁用或存在黑名单记录时也会返回 200,但 code 与 message 表示具体失败原因。
  • 成功时 data.scopeKeys 与 data.defaultScopeKey 与 memberships/login 登录成功响应一致,均为明文 UUID。
  • 支持通过 X-Site header 切换站点,切换后使用对应站点的数据库进行权限校验。

POST 修改密码 /openapi/memberships/change-password

查看详情
通过混合 JWT 令牌提交手机号、旧密码、新密码及新密码确认,完成系统用户或客户端用户的密码修改。优先匹配系统用户(users),未找到时再匹配客户端用户(clientUsers)。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 修改密码令牌,格式为 Bearer TOKEN。令牌 payload 应包含:phone(手机号)、oldPassword(旧密码)、newPassword(新密码)、confirmPassword(新密码确认,须与 newPassword 一致)
X-Site string - 站点标识,决定查询与更新所用的数据库上下文
X-System-Code string - 系统编码。用于指定当前业务系统(例如 AUTH_MANAGEMENT、CONTENT_MANAGEMENT)
响应示例
{
  "success": {
    "code": "0000",
    "message": "密码修改成功",
    "data": {
      "phone": "13800138000",
      "accountType": "user"
    }
  },
  "failureOldPassword": {
    "code": "1305",
    "message": "旧密码错误",
    "data": null
  },
  "failureConfirm": {
    "code": "1205",
    "message": "新密码与确认密码不一致",
    "data": null
  },
  "failurePasswordFormat": {
    "code": "1201",
    "message": "密码需包含字母和数字,且不少于6位",
    "data": null
  },
  "failure": {
    "code": "1002",
    "message": "修改密码信息不完整",
    "data": null
  }
}
注意事项
  • Authorization 使用与注册/登录相同的混合 JWT 封装方式(parseMixedJWT / generateMixedJWT)。
  • 新密码须同时包含字母和数字,长度不少于 6 位。
  • 旧密码校验失败返回 1305;新密码与确认密码不一致返回 1205。
  • 成功时响应 Header X-OpenAPI-Result 为操作结果混合 JWT。
  • 账号被禁用、过期或在黑名单中时与登录接口一致返回相应错误码。

POST 按用户 ID 查询展示名 /openapi/accounts/display-names

查看详情
先校验 Authorization 中的登录访问令牌,再在当前 X-Site 对应的数据库中,按传入的用户主键列表查询系统用户(users)或客户端用户(clientUsers)的展示名。默认库多站点场景仅返回 siteKey 与当前 X-Site 一致且 status=1 的记录;独立站点库仅按 id 与 status 匹配。列表中未找到的 id 不会出现在结果中;全部未命中时 data.list 为空数组。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 会员登录接口返回的访问令牌,格式为 Bearer TOKEN(与 memberships/login 一致,需含 phone 等字段的混合 JWT)
X-Site string - 站点标识,决定查询所用的数据库上下文(与全局 OpenAPI 中间件一致)
X-System-Code string - 系统编码,与其他 OpenAPI 接口一致,用于校验系统是否开放

请求体

{
  "userIds": "array|选填,用户主键列表(_id 字符串或数字 id),最多 200 个;可省略或传 [],鉴权成功后返回空列表"
}

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

响应示例
{
  "success": {
    "code": "0000",
    "message": "查询成功",
    "data": {
      "list": [
        {
          "_id": "MNFIOHH6QOA3kg0z",
          "username": "张三"
        },
        {
          "_id": 12,
          "username": "李四"
        }
      ]
    }
  },
  "failure": {
    "code": "1001",
    "message": "缺少访问令牌",
    "data": null
  }
}
注意事项
  • 鉴权失败(缺少令牌、令牌无效、账号不存在或禁用、黑名单等)时仍返回 HTTP 200,通过 code/message 区分。
  • 每个 id 先在 users 中查找,再在 clientUsers 中查找;同一 id 不会同时返回两条。
  • username 取自 name,若无则 title,再无则空字符串。
  • 请求体中重复的 id 会去重,仅保留首次出现顺序对应的一条命中结果。

POST 资源权限校验 /openapi/permissions/resource-check

查看详情
基于登录令牌校验指定系统下用户是否拥有访问某接口所需的资源与权限。支持通过 X-Site header 切换站点。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 登录接口返回的访问令牌,格式为 Bearer TOKEN
X-Site string - 站点标识。用于切换站点和对应的数据库上下文。如果用户有多个可用站点,可通过此 header 切换。

请求体

{
  "systemCode": "string|必填,目标系统编码",
  "apiName": "string|必填,接口标识(可使用资源 code、name、title 或 URL)",
  "requiredPermissions": "string[]|选填,需要同时具备的权限编码数组"
}

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

响应示例
{
  "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
  }
}
注意事项
  • 若找不到与 apiName 匹配的资源,将返回 code=1501。
  • requiredPermissions 未传时仅校验资源授权,传入时要求全部命中。
  • 出于安全考虑,失败时同样返回 HTTP 200,但 code/message 用于区分失败原因。

POST 账户权限校验 /openapi/permissions/check

查看详情
根据访问令牌校验账户在指定系统下拥有的资源与权限。资源列表以树状结构返回,方便前端渲染菜单等场景。支持通过 X-Site header 切换站点。
请求参数
参数名 必填 类型 示例 说明
Authorization string Bearer {token} 访问令牌,支持系统用户与客户端用户,格式为 Bearer TOKEN
X-Site string - 站点标识。用于切换站点和对应的数据库上下文。如果用户有多个可用站点,可通过此 header 切换。

请求体

{
  "systemCode": "string|必填,要校验的系统编码"
}

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

响应示例
{
  "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
  }
}
注意事项
  • 企业账号会同时合并个人权限与所属组织权限;散客账号仅返回个人权限。
  • 权限列表来自角色继承链,请根据资源类型及 resourceUrls 进行前端路由控制。
  • resources 字段返回树状结构,每个资源节点包含 children 数组,用于前端渲染菜单树。树状结构按 orderNum 排序。
  • resourcesByType 字段按资源类型分组返回,每个类型下的资源也是树状结构,方便前端按类型渲染。
  • 支持通过 X-Site header 切换站点,切换后使用对应站点的数据库进行权限查询,返回该站点下的角色和权限。

POST 提交用户反馈 /openapi/user-feedbacks

查看详情
客户端提交用户反馈,请求 JSON 原样存入 payload 字段。对接方建议采用下方请求体结构,systemCode 来自 X-System-Code 请求头 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识
X-System-Code string - 来源系统编码,会写入 systemCode 字段
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。

请求体

{
  "type": "usage_feedback",
  "questions": [
    {
      "questionId": "experience",
      "question": "您对虎符系统的整体使用体验如何?",
      "options": [
        {
          "value": "excellent",
          "label": "非常满意"
        },
        {
          "value": "good",
          "label": "满意"
        },
        {
          "value": "average",
          "label": "一般"
        },
        {
          "value": "poor",
          "label": "不满意"
        }
      ],
      "answer": {
        "value": "excellent",
        "label": "非常满意"
      }
    },
    {
      "questionId": "recommendation",
      "question": "您是否愿意向同事推荐本系统?",
      "options": [
        {
          "value": "very_willing",
          "label": "非常愿意"
        },
        {
          "value": "willing",
          "label": "愿意"
        },
        {
          "value": "unsure",
          "label": "不确定"
        },
        {
          "value": "unwilling",
          "label": "不愿意"
        }
      ],
      "answer": {
        "value": "very_willing",
        "label": "非常愿意"
      }
    },
    {
      "questionId": "content",
      "question": "详细反馈",
      "answer": {
        "value": "无特殊说明",
        "label": "无特殊说明"
      }
    }
  ]
}

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

响应示例
{
  "success": {
    "code": "0000",
    "message": "提交成功",
    "data": {
      "id": 1,
      "code": "UF0001",
      "systemCode": "AUTH_MANAGEMENT",
      "payload": {
        "type": "usage_feedback",
        "questions": [
          {
            "questionId": "experience",
            "question": "您对虎符系统的整体使用体验如何?",
            "options": [
              {
                "value": "excellent",
                "label": "非常满意"
              },
              {
                "value": "good",
                "label": "满意"
              },
              {
                "value": "average",
                "label": "一般"
              },
              {
                "value": "poor",
                "label": "不满意"
              }
            ],
            "answer": {
              "value": "excellent",
              "label": "非常满意"
            }
          },
          {
            "questionId": "recommendation",
            "question": "您是否愿意向同事推荐本系统?",
            "options": [
              {
                "value": "very_willing",
                "label": "非常愿意"
              },
              {
                "value": "willing",
                "label": "愿意"
              },
              {
                "value": "unsure",
                "label": "不确定"
              },
              {
                "value": "unwilling",
                "label": "不愿意"
              }
            ],
            "answer": {
              "value": "very_willing",
              "label": "非常愿意"
            }
          },
          {
            "questionId": "content",
            "question": "详细反馈",
            "answer": {
              "value": "无特殊说明",
              "label": "无特殊说明"
            }
          }
        ]
      },
      "createTime": "2025-01-01T10:00:00.000Z"
    }
  },
  "failure": {
    "code": "1403",
    "message": "不支持当前系统, 可联系管理员处理",
    "data": null
  }
}
注意事项
  • 请求体 JSON 原样存入 payload 字段,结构不限;对接方建议采用上方请求体示例格式
  • type 建议使用 usage_feedback 标识使用体验类反馈
  • questions 为题目数组:含 questionId、question、options(选择题可选)、answer(含 value 与 label)
  • systemCode 来自 X-System-Code 请求头,无需在 body 中重复传递
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

POST 购买/占用无状态会员 /openapi/stateless-members/purchase

查看详情
将指定无状态会员标记为已售出(saleStatus=1),实现一卡一卖,防止同一卡密被二次购买。不校验、不记录激活状态;已售出卡密在有效期内仍可通过 activate/check 等接口无限次激活。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识
X-System-Code string - 系统编码

请求体

{
  "id": "string|可选,无状态会员 _id 或数字 id",
  "code": "string|可选,无状态会员编码",
  "orderNo": "string|可选,关联订单号,写入 soldOrderNo"
}

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

响应示例
{
  "success": {
    "code": "0000",
    "message": "购买成功",
    "data": {
      "id": "xxx",
      "code": "SM0001",
      "name": "无状态会员",
      "saleStatus": 1,
      "soldAt": "2025-01-15T10:00:00.000Z",
      "soldOrderNo": "ORD-20250115-0010"
    }
  },
  "failureNotFound": {
    "code": "1510",
    "message": "无状态会员不存在",
    "data": null
  },
  "failureDisabled": {
    "code": "1511",
    "message": "无状态会员未启用,不可购买",
    "data": null
  },
  "failureSold": {
    "code": "1512",
    "message": "该无状态会员已售出,不可重复购买",
    "data": null
  }
}
注意事项
  • id 与 code 至少提供一个
  • 仅当 status=1 且 saleStatus=0(或未设置)时可购买
  • 购买成功后 saleStatus=1,同一卡不可再次调用本接口
  • 售卖状态不影响 /openapi/stateless-members/activate、/check 等激活校验接口
  • 管理端也可通过 PUT /api/stateless-members/{id}/sale-status 或订单 statelessMemberId + PAID/COMPLETED 标记已售

POST 激活无状态会员 /openapi/stateless-members/activate

查看详情
激活无状态会员,通过X-Member-Key header中的混合JWT解密得到密钥,校验会员有效性后生成新的密钥令牌返回。
请求参数
参数名 必填 类型 示例 说明
X-Member-Key string - 会员密钥令牌,通过混合JWT加密
X-System-Code string - 系统编码,用于判断会员类型是否支持当前系统
X-Site string - 站点标识
响应示例
{
  "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
  }
}
注意事项
  • 如果X-Member-Key的JWT解析已过期,返回错误:激活已超时,请重新绑定激活
  • 校验无状态密钥是否存在且有效,且没有过期
  • 校验关联会员类型记录是否存在且有效
  • 通过X-System-Code判断会员类型是否支持当前系统
  • 校验通过后,用混合JWT加密生成新的密钥返回
  • 不满足条件返回:您绑定的会员码无效
  • 不校验售卖状态(saleStatus),已售出卡密在有效期内仍可激活

POST 检查无状态会员有效性 /openapi/stateless-members/check

查看详情
检查无状态会员是否还有效,通过X-Member-Key header中的混合JWT解密得到密钥,校验会员状态、过期时间、系统支持等,返回剩余天数。
请求参数
参数名 必填 类型 示例 说明
X-Member-Key string - 会员密钥令牌,通过混合JWT加密
X-System-Code string - 系统编码,用于判断会员类型是否支持当前系统
X-Site string - 站点标识
响应示例
{
  "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
  }
}
注意事项
  • 如果X-Member-Key的JWT解析已过期,返回错误:传入的会员需要重新绑定
  • 判断无状态密钥是否存在且有效
  • 关联会员类型记录是否存在且有效,不存在或无效返回:您绑定的会员无效
  • 判断是否过期,已过期返回:会员已过期
  • 通过X-System-Code判断会员类型是否支持当前系统,不支持返回:当前会员码不支持当前系统
  • 返回会员还有多少天到期(基于会员有效期、当天日期、会员生效日期计算剩余时间按天计)
  • 不满足条件返回:您绑定的会员码无效

POST 检查无状态会员功能有效性 /openapi/stateless-members/functionCheck

查看详情
在检查无状态会员有效性的基础上,额外通过X-Function header检查会员功能模块中是否有该功能。
请求参数
参数名 必填 类型 示例 说明
X-Member-Key string - 会员密钥令牌,通过混合JWT加密
X-System-Code string - 系统编码,用于判断会员类型是否支持当前系统
X-Function string - 功能代码,用于检查会员功能模块中是否有该功能
X-Site string - 站点标识
响应示例
{
  "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
  }
}
注意事项
  • 在/stateless-members/check功能基础上,通过Header的X-Function额外检查会员功能模块
  • 如果会员功能模块中有该功能则通过,没有则返回:当前会员不支持当前功能
  • 支持通过moduleCode或moduleId查找功能模块
  • 功能模块类型可以是Resource(绑定资源)或Custom(自定义模块名称)

POST 无状态会员有效性校验(场景A) /openapi/stateless-members/valid-check

查看详情
场景A:仅校验无状态会员是否有效(未过期),不校验会员类型与系统的支持关系。适用于第三方只需确认会员是否开通且未到期的简单场景。
请求参数
参数名 必填 类型 示例 说明
X-Member-Key string - 会员密钥令牌(混合JWT加密,payload.data = secretKey)
X-Site string - 站点标识
X-System-Code string - 系统编码(用于路由到正确数据库,本接口不校验系统-会员类型兼容性)
响应示例
校验通过:
{
  "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
}
注意事项
  • X-Member-Key 为激活接口返回的 keyToken(混合JWT),到期后需重新调用 /activate 接口
  • 本接口不校验系统支持关系,适合场景A(只验有效性)
  • 场景B(验系统支持)请使用 /stateless-members/check
  • 场景C(验功能模块)请使用 /stateless-members/functionCheck
  • 场景D(验功能限额)请使用 /stateless-members/limitCheck

POST 无状态会员限额校验(场景D) /openapi/stateless-members/limitCheck

查看详情
场景D:在场景C(功能模块校验)的基础上,进一步校验当前功能模块的使用量是否已达到配置的上限(limitValue)。适用于有次数或存储上限控制的业务场景。
请求参数
参数名 必填 类型 示例 说明
X-Member-Key string - 会员密钥令牌(混合JWT加密)
X-Site string - 站点标识
X-System-Code string - 系统编码
X-Function string - 功能模块代码(moduleCode),如 VIDEO_DOWNLOAD

请求体

{
  "currentCount": "number|必填,当前已使用次数/数量(由第三方系统维护),如 8"
}

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

响应示例
校验通过(有限额):
{
  "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
}
注意事项
  • limit 字段为 null 表示该功能未配置限额,即不限次数
  • limit.remaining = limit.value - currentCount,小于等于0时拒绝
  • currentCount 由第三方系统自行维护并传入,本系统不做存储
  • 限额配置在管理后台 会员功能限制(memberFunctionLimits)中设置

GET 用户管理 - 分页列表查询 /openapi/users/list

查看详情
分页查询用户管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统

GET 用户管理 - 简单列表查询 /openapi/users/list/simple

查看详情
无分页返回用户管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统

GET 客户端用户管理 - 分页列表查询 /openapi/client-users/list

查看详情
分页查询客户端用户管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统

GET 客户端用户管理 - 简单列表查询 /openapi/client-users/list/simple

查看详情
无分页返回客户端用户管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统

GET 组织管理 - 分页列表查询 /openapi/organizations/list

查看详情
分页查询组织管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统

GET 组织管理 - 简单列表查询 /openapi/organizations/list/simple

查看详情
无分页返回组织管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统

GET 部门管理 - 分页列表查询 /openapi/departments/list

查看详情
分页查询部门管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 部门管理 - 简单列表查询 /openapi/departments/list/simple

查看详情
无分页返回部门管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 岗位管理 - 分页列表查询 /openapi/positions/list

查看详情
分页查询岗位管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 岗位管理 - 简单列表查询 /openapi/positions/list/simple

查看详情
无分页返回岗位管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 职员管理 - 分页列表查询 /openapi/staff/list

查看详情
分页查询职员管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 职员管理 - 简单列表查询 /openapi/staff/list/simple

查看详情
无分页返回职员管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 角色管理 - 分页列表查询 /openapi/roles/list

查看详情
分页查询角色管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统

GET 角色管理 - 简单列表查询 /openapi/roles/list/simple

查看详情
无分页返回角色管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统

GET 资源管理 - 分页列表查询 /openapi/resources/list

查看详情
分页查询资源管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统

GET 资源管理 - 简单列表查询 /openapi/resources/list/simple

查看详情
无分页返回资源管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统

GET 权限管理 - 分页列表查询 /openapi/permissions/list

查看详情
分页查询权限管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统

GET 权限管理 - 简单列表查询 /openapi/permissions/list/simple

查看详情
无分页返回权限管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统

GET 客户管理 - 分页列表查询 /openapi/customers/list

查看详情
分页查询客户管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 客户管理 - 简单列表查询 /openapi/customers/list/simple

查看详情
无分页返回客户管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 订单管理 - 分页列表查询 /openapi/orders/list

查看详情
分页查询订单管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 订单管理 - 简单列表查询 /openapi/orders/list/simple

查看详情
无分页返回订单管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 会员管理 - 分页列表查询 /openapi/members/list

查看详情
分页查询会员管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 会员管理 - 简单列表查询 /openapi/members/list/simple

查看详情
无分页返回会员管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 无状态会员管理 - 分页列表查询 /openapi/stateless-members/list

查看详情
分页查询无状态会员管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
saleStatus number - 售卖状态:0-未售(可购买),1-已售。筛选未售时包含无 saleStatus 历史数据
响应示例
{
  "success": {
    "code": "0000",
    "message": "查询成功",
    "data": {
      "list": [
        {
          "id": 1,
          "code": "SM0001",
          "name": "无状态会员",
          "description": "无状态会员描述",
          "status": 1,
          "saleStatus": 0,
          "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选,含 saleStatus 筛选可售库存(saleStatus=0)
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 无状态会员管理 - 简单列表查询 /openapi/stateless-members/list/simple

查看详情
无分页返回无状态会员管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
saleStatus number - 售卖状态:0-未售,1-已售
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "success": {
    "code": "0000",
    "message": "查询成功",
    "data": {
      "list": [
        {
          "id": 1,
          "code": "SM0001",
          "name": "无状态会员",
          "description": "无状态会员描述",
          "status": 1,
          "saleStatus": 0,
          "memberTypeId": "MT0001",
          "validityDays": 365,
          "effectiveDate": "2025-01-01",
          "createTime": "2025-01-01T10:00:00.000Z",
          "updateTime": "2025-01-01T10:00:00.000Z"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选,含 saleStatus
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 会员用户管理 - 分页列表查询 /openapi/member-users/list

查看详情
分页查询会员用户管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 会员用户管理 - 简单列表查询 /openapi/member-users/list/simple

查看详情
无分页返回会员用户管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 会员功能管理 - 分页列表查询 /openapi/member-functions/list

查看详情
分页查询会员功能管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 会员功能管理 - 简单列表查询 /openapi/member-functions/list/simple

查看详情
无分页返回会员功能管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 会员类型管理 - 分页列表查询 /openapi/member-types/list

查看详情
分页查询会员类型管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 会员类型管理 - 简单列表查询 /openapi/member-types/list/simple

查看详情
无分页返回会员类型管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 会员功能限制管理 - 分页列表查询 /openapi/member-function-limits/list

查看详情
分页查询会员功能限制管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 会员功能限制管理 - 简单列表查询 /openapi/member-function-limits/list/simple

查看详情
无分页返回会员功能限制管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 白名单管理 - 分页列表查询 /openapi/whitelists/list

查看详情
分页查询白名单管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 白名单管理 - 简单列表查询 /openapi/whitelists/list/simple

查看详情
无分页返回白名单管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 黑名单管理 - 分页列表查询 /openapi/blacklists/list

查看详情
分页查询黑名单管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 黑名单管理 - 简单列表查询 /openapi/blacklists/list/simple

查看详情
无分页返回黑名单管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。 业务数据接口需提供 X-Scope-Key。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
X-Scope-Key string 550e8400-e29b-41d4-a716-446655440000 数据 scope 分区标识(UUID)。OpenAPI 业务数据读写接口必填。登录/注册响应中的 defaultScopeKey 为默认写入/查询分区;有组织时默认使用组织 scope,无组织时使用个人 scope。禁止在 query 中传 scopeKey/organizationId 自选范围。
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统
  • 必须提供有效的 X-Scope-Key header,仅返回该 scope 分区内的数据
  • 禁止通过 query 传递 scopeKey 或 organizationId 自选数据范围

GET 系统管理 - 分页列表查询 /openapi/support-systems/list

查看详情
分页查询系统管理状态有效的列表数据,支持多种可选查询条件用于筛选。必须提供有效的X-Site和X-System-Code header。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
参数名 必填 类型 示例 说明
pageNum number - 页码,默认1
pageSize number - 每页数量,默认10
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
响应示例
{
  "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
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 支持多种可选查询条件进行筛选
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统

GET 系统管理 - 简单列表查询 /openapi/support-systems/list/simple

查看详情
无分页返回系统管理前100条状态有效数据的列表,支持多种可选查询条件用于筛选以及排序。必须提供有效的X-Site和X-System-Code header。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
参数名 必填 类型 示例 说明
name string - 名称(模糊搜索)
code string - 编码(模糊搜索)
sortBy string - 排序字段,默认createTime
sortOrder string - 排序方向:asc-升序,desc-降序,默认desc
响应示例
{
  "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"
        }
      ]
    }
  }
}
注意事项
  • 只返回状态为有效的记录(status=1)
  • 最多返回100条数据
  • 支持多种可选查询条件进行筛选
  • 支持排序功能
  • 必须提供有效的X-Site header,查询对应站点的数据
  • 必须提供有效的X-System-Code header,支持客户端系统

GET 站点数据 - 列表查询 /openapi/sites/list

查看详情
返回用户名和对应站点key的列表,用于查看。必须提供有效的X-Site和X-System-Code header。
请求参数
参数名 必填 类型 示例 说明
X-Site string - 站点标识(必填)
X-System-Code string - 系统编码(必填)
参数名 必填 类型 示例 说明
name string - 站点名称(模糊搜索)
响应示例
{
  "success": {
    "code": "0000",
    "message": "查询成功",
    "data": {
      "list": [
        {
          "userName": "张三",
          "siteKey": "47F38C4F-3437-4108-96EE-0621B30EF2B9-7B75868C742688BD3",
          "siteName": "个人站点"
        }
      ]
    }
  }
}
注意事项
  • 返回用户名和对应站点key
  • 必须提供有效的X-Site header
  • 必须提供有效的X-System-Code header