← 返回首页

API模块详情

当前查看模块：auditRecord

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

参数名 必填 类型 示例 说明
Authorization 否 string Bearer <JWT token> 用户登录后的 JWT 令牌。若已登录可直接使用，无需传 X-Client。。认证 Token，请在请求头中携带，推荐格式：Bearer {token}
X-Client 否 string <client key token> 客户端密钥。当未携带或无法使用 Authorization 时必填，用于密钥认证。线上文档： http://localhost:5601/docs
X-Site 是 string <site key> 站点标识（必填）。用于切换站点和对应的数据库上下文。所有 OpenAPI 接口必须提供有效的 X-Site header。
X-System-Code 是 string AUTH_MANAGEMENT 系统编码（必填，鉴权用）。校验调用方声明的业务系统是否属于当前 X-Site 站点下已启用的 securitySystems 白名单；不用于覆盖请求体中的 systemId 等业务字段。不在白名单时返回「不支持当前系统，可联系管理员处理」。

API响应码列表

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

成功响应码 (1个)

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

错误响应码 (48个)

参数名 必填 类型 示例 说明
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 手机号已注册客户端用户 该手机号已被注册为客户端用户
1210 否 string 站点标识生成失败，请稍后重试 生成站点标识时发生错误
1211 否 string 拒绝无效访问 站点标识无效或访问被拒绝
1212 否 string 注册申请已提交，待审核 注册信息已入库且账号处于禁用状态，需管理端审核通过后方可启用；在 X-Individualism=true（开独立站点）或企业注册（系统用户）时返回；下游应视为待审核而非注册成功
1303 否 string 请同意隐私等协议 散客账号登录时必须同意隐私协议
1304 否 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 操作失败 / 服务器内部错误 / 数据库操作失败 服务器内部错误，操作失败或数据库操作异常

审核管理

模块标识: auditRecord | 接口数量: 6

GET 获取审核记录列表 /api/audit-records

查看详情
分页获取审核记录列表，支持按审核类型、状态、系统来源、关联ID筛选
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数
参数名 必填 类型 示例 说明
pageNum 否 number - 页码，默认1
pageSize 否 number - 每页数量，默认10
auditType 否 string - 审核类型：REGISTER_USER（注册-用户）、REGISTER_CLIENT（注册-客户端）
status 否 number - 审核状态：0-待审核，1-通过，2-拒绝
systemSource 否 string - 系统来源编码
relatedId 否 string - 关联业务记录ID
响应示例
{
  "success": {
    "code": "0000",
    "message": "获取成功",
    "data": {
      "list": [
        {
          "id": 1,
          "code": "AR0001",
          "auditType": "REGISTER_USER",
          "relatedId": "user-id",
          "relatedCollection": "users",
          "individualism": true,
          "status": 0,
          "applyTime": "2025-01-01T10:00:00.000Z",
          "auditTime": null,
          "auditRemark": null,
          "auditor": null,
          "siteKey": "86AFEA7A-xxxx",
          "systemSource": "AUTH_MANAGEMENT"
        }
      ],
      "total": 1,
      "pageNum": 1,
      "pageSize": 10,
      "totalPages": 1
    }
  }
}

GET 获取审核记录详情 /api/audit-records/{id}

查看详情
根据ID获取审核记录详情
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数
参数名 必填 类型 示例 说明
id 是 string - 审核记录ID
响应示例
{
  "success": {
    "code": "0000",
    "message": "获取成功",
    "data": {
      "id": 1,
      "code": "AR0001",
      "auditType": "REGISTER_CLIENT",
      "relatedId": "client-user-id",
      "status": 0,
      "applyTime": "2025-01-01T10:00:00.000Z",
      "siteKey": "86AFEA7A-xxxx",
      "systemSource": "AUTH_MANAGEMENT"
    }
  },
  "failure": {
    "code": "4040",
    "message": "审核记录不存在",
    "data": null
  }
}

POST 创建审核记录 /api/audit-records

查看详情
管理端手动创建审核记录（OpenAPI 注册会自动创建）
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数

请求体

{
  "auditType": "string｜必填，REGISTER_USER 或 REGISTER_CLIENT",
  "relatedId": "string｜必填，关联业务记录 _id",
  "relatedCollection": "string｜可选，users 或 clientUsers",
  "individualism": "boolean｜可选，注册类审核是否需开通独立站点",
  "organizationId": "string｜可选，企业注册时的组织ID",
  "systemSource": "string｜可选，系统来源编码",
  "applyRemark": "string｜可选，申请备注"
}

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

响应示例
{
  "success": {
    "code": "0000",
    "message": "创建审核记录成功",
    "data": {
      "id": 1,
      "code": "AR0001",
      "auditType": "REGISTER_USER",
      "status": 0,
      "applyTime": "2025-01-01T10:00:00.000Z"
    }
  }
}

PUT 更新审核记录 /api/audit-records/{id}

查看详情
更新待审核记录的备注等信息（仅 status=0 可更新）
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数
参数名 必填 类型 示例 说明
id 是 string - 审核记录ID

请求体

{
  "auditRemark": "string｜可选，审核备注",
  "applyRemark": "string｜可选，申请备注"
}

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

响应示例
{
  "success": {
    "code": "0000",
    "message": "更新审核记录成功",
    "data": {
      "id": 1,
      "code": "AR0001",
      "applyRemark": "补充说明"
    }
  }
}

DELETE 删除审核记录 /api/audit-records/{id}

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

POST 审核（通过/拒绝） /api/audit-records/{id}/review

查看详情
对待审核记录执行通过或拒绝。通过时按 auditType 调用对应业务执行器：注册类审核会启用账号，若 individualism=true 且 ENABLE_SITE_PROVISIONING 开启则开通独立站点
导出 JSON 导出 Markdown
导出 Postman Collection 导出 OpenAPI 规范
请求参数
参数名 必填 类型 示例 说明
id 是 string - 审核记录ID

请求体

{
  "status": "number｜必填，1-通过，2-拒绝",
  "auditRemark": "string｜可选，审核备注"
}

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

响应示例
{
  "success": {
    "code": "0000",
    "message": "审核通过",
    "data": {
      "record": {
        "id": 1,
        "code": "AR0001",
        "status": 1,
        "auditTime": "2025-01-01T11:00:00.000Z",
        "auditor": "13800000000"
      },
      "executionResult": {
        "accountType": "company",
        "site": {
          "siteKey": "A1B2C3D4-xxxx"
        }
      }
    }
  },
  "failure": {
    "code": "4090",
    "message": "该审核记录已处理，无法重复审核",
    "data": null
  }
}
注意事项
  • 审核类型 REGISTER_USER / REGISTER_CLIENT 分别对应注册-用户、注册-客户端业务执行器
  • 扩展新审核类型时，在 auditApprovalExecutorRegistry 注册新的执行策略即可