Содержание

附录 B 接口与数据清单

本文档逐条登记该系统对外提供的1057个接口及其分块分布,列明数据导入导出与外部直连的口子和边界,并给出字段登记模板、指标口径速查与保留参数,供验收逐条核对。

  • 接口合计1057个:管理端842、移动端160、学院端55
  • 体检接口组最多58个,二十组占总接口四成余
  • 16个表格导入入口、44个导出端点,异步导出12小时清理
  • 字段登记须写死合法取值,敏感级别与审批由学校签字
  • 报到完成率等口径须先统一量纲,线上办结率、录取报到率算不出

正文讲这套系统替学校办成了什么事,附录留下两组能被逐条核对的账:对外提供多少接口、数据从哪些口子进出。

这一段先说清统计口径,免得数字被误读:接口数按逐条登记的请求方法计数,按接口组所在文件归并;分块依据是目录位置,因此下面第一张表的"管理端"里同时包含了后台管理接口与挂在同一目录下的门户公开接口。所有合计与分块数字与全书基线表同源,不存在第二处取值。

B.1 接口规模与分布

分块接口数说明
管理端目录842后台管理接口,以及与后台同目录的门户与师生公开接口
移动端160全部挂在移动端路由前缀之下,凭学生或工作人员身份访问
学院端55经统一基类做组织授权范围过滤,无授权记录即为空集
合计1057三块相加即总数

一句实话:接口数量本身不是优势,多出来的接口往往是没人调用的历史包袱。这个数真正能说明的只有一件事——这个系统的业务面铺开过,不是演示型的壳子。

B.2 规模最大的接口组(二十组,合计 455)

下表列出接口数不少于十六个的组,其余长尾组合计 602 个。

接口组数量覆盖的业务动作
体检58排期、时段、号源、预约、结果录入、异常、通知、健康信息填报
新生名册32导入、扩展字段、分组隶属、检索、批量维护
批次与任务29批次增删改、任务装配、克隆、准备与授权连带
选宿27设施、配置、预选、正式选、记录、统计、资格校验
人员与账号26账号、身份、组织隶属、导入同步、锁定期限
缴费25收费项目、账单、实缴与减免、绿色通道、押金、贷款回执
宿舍24栋、层、房间、床位、户型、同步
移动端统计22学生与工作人员看到的进度与看板
身份验证22证件读取、号码比对、人像比对、结论与熔断、日志
学院端工作台20首屏四卡、报到趋势、本院待办
报表19各类汇总与明细报表
现场工作管理18工作分派、扫码核验、办理记录
学院端数据17本院新生、任务、统计的读取与导出
师生端新生办理17学生本人可见可办的动作
组织架构17五级组织的增删改查与同步
问卷17问卷、题目、发放、答卷、统计、匿名与积分
房间与床位17房间明细与床位状态
登录16账号登录、统一登录回执、令牌签发与刷新
来校行程16行程填报、时段统计、接站与车辆
站点配置16门户栏目、轮播、链接位

这二十组占了全部接口的四成余,其余六百余个散落在字典、图文、投票、标签、订单、保险、志愿者、主题、备份、日志、消息这些支撑性入口上。看接口分布比看功能清单更能看出一个系统的重心在哪:这里的重心明显在办理与数据进出,不在展示。

B.3 数据交换面

数据进出的口子是验收当天最容易出问题的地方,全部列出来。

交换动作数量或形态状态边界
表格导入入口16 个已交付逐个业务对象分别实现,新增一类对象的导入属于开发工作
导入错误回执两套已交付一套带行号与原因,一套仅带行号;统一为在建项
进门校验必填、类型、字典格式已交付值域强制收敛按批次;字典字段格式校验未全部接入线上入口
导出端点44 个已交付字段列由采集字典动态列举,加一列即多一列
异步导出排队、状态可查、临时文件十二小时后连记录一并清理已交付大表走这条路
同步直接下载不落任务记录已交付小表用这条路,因此"每一次导出都有记录"这句话现在只能说一半
导出审批、水印、用途登记按批次四件套未到位
外部来源直连四类已交付只允许查询语句且禁分号;连接超时三十秒;映射为空时按别名直通
定时同步可配周期已交付同步前有防误清保护
去重合并按唯一编号,多源定主源优先已交付去重键不是证件号
批量作业监控执行中、排队、完成、失败四数已交付单队列串行执行,超时十分钟终止

B.4 字段登记模板

字段清单不该只有程序看,得有一张学校签过字的登记表。下面是一份最小可用样张,前五行按本系统现有字段填实,最后一行故意留空示意。

字段来源是否必填合法取值敏感级别出门须审批责任人
学号校方名册同步全校唯一,不含空格内部学籍管理岗
姓名校方名册同步与名册一致内部学籍管理岗
证件号校方名册同步十八位,末位可为字母敏感信息部门
手机号学生自填十一位数字敏感学工办
住宿或走读学生自填二选一内部宿管
(留空行,由学校按校本字段续填)

三条填写纪律:

  • 合法取值那一列必须写死。 现在最容易出错的地方是同一个字段在上游有四种写法,进门时没归一,出口处按四种写法各算一次。
  • 敏感级别与"出门须审批"两列必须由学校签字。 分级这件事,厂商定的级别不算数,因为数据的责任主体是学校。
  • 责任人一列不能空。 填不出责任人的字段,说明它没有业务归属,应当删掉。

B.5 口径速查

同样是"率",分母不同就不是同一个指标。这张表把最容易打架的五条固定下来。

指标分子分母量纲现在能不能算
名册内报到完成率已报到人数已导入名册的应到人数两种写法并存,须统一能,但要先统一量纲
缴费率已缴人数名册总人数百分数
宿舍分配率已分配床位人数名册总人数百分数
体检完成率已体检人数名册总人数百分数
任务完成率该任务已完成人数该任务应完成人数小数能,分组或前置限制时与上面四条分母不同
线上办结率本人自助办结人数名册总人数百分数算不出,无渠道列
录取报到率报到人数录取人数百分数算不出,系统内无录取与招生计划数据

一句提醒:界面上一处列名叫"招生数",实际是已导入名册的人数。 汇报时把这一列念成招生规模,会被懂行的人当场问住。列名待改,改之前的正确说法是"名册人数"。

B.6 学校侧要准备的东西

这套系统开箱可用,但有三类事情必须在外部先落定,否则相应能力只能停在接口就绪的状态。

要准备的事项由谁负责提前多久启动系统侧已就绪的部分
上游系统只读账号与视图学校信息部门数据接入联调前四类来源直连、字段映射、调度、去重合并
短信或订阅消息签名与模板学校与通道服务商以通道审批周期为准定向发放、逐人展开、模板占位与频控设计
统一登录平台的对接资料学校与平台方上线前一次联调多家国内平台对接经验、账号映射与权限收敛
证件照或人像数据来源学校招生或学籍部门身份核验启用前读取、比对、打分、熔断、留痕五段链路与替换接口
收银渠道与商户资质学校财务缴费上线前一到两个月账单、分项、减免、凭证登记、对账口径导出
卡片系统与门禁设备学校一卡通中心领用环节启用前任务类型与办理记录,卡片本身不归软件管
心理测评的量表与接手机制学校心理中心明确责任人之后再排期入口外链与结果承接位;不自动预警
字段定级与指标口径的签字学校分管校领导第一批交付前参考表、样张、填写纪律

B.7 保留与生命周期参数

数据留多久、临时东西多久清掉,这些都是要在验收材料里写死的数。

项目现行取值状态
每日全量备份保留三十天已交付
周期性基线快照保留两份已交付
恢复演练还原到临时库比对表数与行数,用后即删已交付
时点恢复的日志链清理策略未落地在建
异步导出临时文件与任务记录十二小时清理已交付
批量作业超时终止十分钟已交付
运行配置缓存十分钟已交付
界面主题下发缓存三十分钟已交付
身份核验防伪缓存依赖有效期,非加密事实边界
归档、保留期、去标识化、注销尚无自动动作按批次

最后一条是本附录里最该被问的一句:数据留到什么时候、由谁批准删除,现在靠学校的管理制度,不靠系统的自动机制。制度先行,系统才可能跟上。