{ "openapi": "3.0.3", "info": { "title": "审核管理", "version": "1.0.0", "description": "审核管理相关接口文档" }, "paths": { "/api/audit-records": { "get": { "summary": "获取审核记录列表", "description": "分页获取审核记录列表，支持按审核类型、状态、系统来源、关联ID筛选", "parameters": [ { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "auditType", "in": "query", "required": false, "schema": { "type": "string" }, "description": "审核类型：REGISTER_USER（注册-用户）、REGISTER_CLIENT（注册-客户端）" }, { "name": "status", "in": "query", "required": false, "schema": { "type": "number" }, "description": "审核状态：0-待审核，1-通过，2-拒绝" }, { "name": "systemSource", "in": "query", "required": false, "schema": { "type": "string" }, "description": "系统来源编码" }, { "name": "relatedId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "关联业务记录ID" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } }, "post": { "summary": "创建审核记录", "description": "管理端手动创建审核记录（OpenAPI 注册会自动创建）", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "auditType": { "type": "string", "description": "string｜必填，REGISTER_USER 或 REGISTER_CLIENT" }, "relatedId": { "type": "string", "description": "string｜必填，关联业务记录 _id" }, "relatedCollection": { "type": "string", "description": "string｜可选，users 或 clientUsers" }, "individualism": { "type": "boolean", "description": "boolean｜可选，注册类审核是否需开通独立站点" }, "organizationId": { "type": "string", "description": "string｜可选，企业注册时的组织ID" }, "systemSource": { "type": "string", "description": "string｜可选，系统来源编码" }, "applyRemark": { "type": "string", "description": "string｜可选，申请备注" } }, "required": [ "auditType", "relatedId" ] } } } }, "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "创建审核记录成功", "data": { "id": 1, "code": "AR0001", "auditType": "REGISTER_USER", "status": 0, "applyTime": "2025-01-01T10:00:00.000Z" } } } } } } } } }, "/api/audit-records/{id}": { "get": { "summary": "获取审核记录详情", "description": "根据ID获取审核记录详情", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "审核记录ID" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } }, "put": { "summary": "更新审核记录", "description": "更新待审核记录的备注等信息（仅 status=0 可更新）", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "审核记录ID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "auditRemark": { "type": "string", "description": "string｜可选，审核备注" }, "applyRemark": { "type": "string", "description": "string｜可选，申请备注" } } } } } }, "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "更新审核记录成功", "data": { "id": 1, "code": "AR0001", "applyRemark": "补充说明" } } } } } } } }, "delete": { "summary": "删除审核记录", "description": "删除指定的审核记录", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "审核记录ID" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "删除审核记录成功", "data": { "result": true } } } } } } } } }, "/api/audit-records/{id}/review": { "post": { "summary": "审核（通过/拒绝）", "description": "对待审核记录执行通过或拒绝。通过时按 auditType 调用对应业务执行器：注册类审核会启用账号，若 individualism=true 且 ENABLE_SITE_PROVISIONING 开启则开通独立站点", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "审核记录ID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number", "description": "number｜必填，1-通过，2-拒绝" }, "auditRemark": { "type": "string", "description": "string｜可选，审核备注" } }, "required": [ "status" ] } } } }, "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "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 } } } } } } } } } }