附件3:
数据对接规范
一、概述
本数据采集接口传输规范描述了省级平台如何将数据传输到国家平台评估管理系统中的规范要求。
二、接口传输协议
使用SFTP(Secure File Transfer Protocol)协议传输接口数据文件,保证数据传输过程安全。各个省级平台使用传输数据文件的方式来上报数据。省级平台定时向指定服务器上传数据文件,省级平台定时去相应数据目录获取数据文件。
三、数据传输地址及接口目录要求
(一)数据传输目录地址及目录访问权限维护
省级平台通过以下地址实现将省级数据对接传输至国家平台评估管理系统:
SFTP://59.252.48.23/[省级目录名]。
省级平台的接口数据文件存放至国家平台评估管理系统的文件服务器中,国家平台为各省级平台创建独立的账号、数据存储目录,以及配置相应的权限。
(二)接口目录文件维护
省级平台将文件上传至接口目录后不负责清理,由国家平台处理后删除。
四、接口数据要求
省级平台在生成接口文件时,必须遵守如下数据要求:
(一)分隔符要求
1.记录间分隔符:回车换行符(0x0D0A);
2.字段间分隔符:ASCII码0x01(不可见字符),每行数据最后一个字段后也带“0x01”。
为了保证数据的准确性以及接口文件中的记录各值域在有效的取值范围内,数据中均不能包含0x0D0A(回车换行符)、0x0D(回车符)、0x0A(换行符)和字段间分隔符。
特定接口单元的数据文件中,字段数量及顺序应该绝对固定,即:对于描述为“非必填”的字段,接口数
据中不可省略,无值就留空。
(二)数据格式要求
1.编码格式
(1)UTF-8
2.日期类型
(1)日期类型统一采用YYYY-MM-DD格式,不允许出现空值,且YYYY-MM-DD必须为有意义的日期:
1)YYYY为四位数字,必须是有效的年份
文件名的命名规则2)MM为两位数字,必须是有效的月份(01-12)
3)DD为两位数字,必须是有效的日期(01-31)
(2)对于不符合日期约束规则的日期值,处理方式存在以下两种情况:
1)无值的日期或者无意义的日期,这时在接口中一律以“1970-01-01”填充;
2)接口中的“失效日期”在表示“未失效”含义时,一律以
“2999-12-31”(公元2999年12月31日)填充。
3.时间类型
(1)统一采用HH:MM:SS格式:
1)HH为两位数字,必须是有效的小时(00-23),24小时制;
2)为两位数字,必须是有效的分钟(00-59);
3)为两位数字,必须是有效的秒(00-59)。
4.日期时间类型
统一采用YYYY-MM-DD HH:MM:SS格式,格式要求见日期类型和时间类型。注意,日期与时间中间有一个半角空格符。
5.字段长度
接口单元中所定义的每个字段不限定最大长度,填充实际数据,由于已经定义了字段分隔符,因此若实际字段值未达最大长度,无需左补或右补空格。
6.内容字段
内容字段中不可以包含回车换行符,如果包含,需要替换成半角空格符号。
五、接口文件要求
(一)接口文件命名规则
<;文件名前缀>_<;接口单元编码>_<;数据日期>_<;序列号>.<;文件后缀> 说明:
1.文件名前缀包括如下几种:
SEND:标识文件为省级平台上传给省级平台
GET:标识文件为省级平台传给省级平台
2.接口单元编码为4位数字,代表数据源接口的编码。
3.<;数据日期>按不同的接口类型确定,如为小时接口,取值为“YYYYMMDDHH”;若为日接口或月接口则为“YYYYMMDD”。
4.<;序列号>代表文件序号,当上报时段内的数据量过大时,可进行拆分,拆分最小单位是行。建议每五万条记录拆分一个文件。
5.<;文件后缀>包含以下情况:
不要求压缩的文本数据文件无<;文件后缀>。
要求压缩的文本数据文件后缀为“ZIP”。
(二)文件上传过程中临时后缀要求
省级平台向文件服务器接口目录上传文件时,需在文件名末位增加一个临时后缀名,该后缀名固定为‘uploading ’,上完成后自动将临时后缀名删除。格式如下:
<;正式文件名> .uploading
六、抽取周期要求
(一)按小时的接口。省级平台保证每个整点第30分钟前生成完上一个小时的数据,并上传至省级平台文件服务器接口目录;
(二)按日的接口。省级平台保证每日6点前,生成完前一天的增量数据,并上传至省级平台文件服务器接口目录;
(三)按月的接口。省级平台保证每月1日6点前,生成完前一个月的增量数据,并上传至省级平台文件服务器接口目录。
七、异常处理要求
(一)省级平台触发
国家平台对省级平台生成的接口文件进行校验,经过校验并发现错误后,省级平台根据错误描述修改问题重新生成接口文件。
1.异常发现
国家平台在获取接口文件后,对接口文件进行校验,校验中发现的问题和异常将在校验信息反馈文件中描述。并将错误的数据文件名
增加后缀.error,供省级平台分析参考。
反馈文件由省级平台存放至文件服务器上,文件命名格式为:
GET_<;接口单元编码>_<;数据日期>_<;序列号>
其中,接口单元编码,数据日期,序列号均为发现错误的数据文件名中提取。
(2)异常处理
省级平台每小时检测省级平台是否生成了GET异常处理文件,发现该类型文件后,省级平台应对异常文件进行分析,并根据错误信息,重新处理生成关联的数据文件上传。
(二)省级平台触发
当省级平台发现已生成的数据异常时,需要对异常数据的影响进行评估,在评估后决定这些数据是否需要重新生成。如果需要,重新生成接口数据文件数据,重新上传。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论