1、广东省食安员综合监管平台接口规范文档 V1.02017-11广东省食安员综合监管平台 Version: 1.0.0接口规范文档 Date: 2017-11-24Page: 2 of 39改版记录版本 发布日期 描述 作者 复审 批准1.0 2017/11/24 建立该文档,初稿变更记录变更编号 日期 变更项 描述 基线版本 变更请求编号广东省食安员综合监管平台 Version: 1.0.0接口规范文档 Date: 2017-11-24Page: 3 of 39目录1 文档概述 .52 适用范围 .53 接口架构 .53.1 接口逻辑架构 .53.2 实时监控流程 .64 接口概述 .64.1
2、接口概述 .64.2 数据类型与格式 .64.3 接口参数格式 .74.3.1 请求参数 .74.3.2 响应参数 .84.4 接口访问地址 .105 接口详细参数和格式 .105.1 系统管理 .105.1.1 系统通知消息 .105.2 省平台业务验证串 .105.2.1 数字签名生成功能接口 .115.3 食安平台考试培训管理接口 .125.3.1 业务机构登记接口 .125.3.2 培训师登记 .145.3.3 食安学员培训报名 .175.3.4 考场登记 .195.3.5 考场座位安排 .215.3.6 考试科目登记 .235.3.7 食安培训课程开设 .255.3.8 培训师授课安
3、排 .27广东省食安员综合监管平台 Version: 1.0.0接口规范文档 Date: 2017-11-24Page: 4 of 395.4 食安平台考试培训监控接口 .295.4.1 食安员考试签到认证 .305.4.2 食安员上机考试核验 .325.4.3 考生考试过程监控接口 .345.4.4 考场监控设备实时视频接口 .366 附录：字典 .386.1 接口功能编号 .38广东省食安员综合监管平台 Version: 1.0.0接口规范文档 Date: 2017-11-24Page: 5 of 39食安员管理平台 接口设计文档1 文 档 概 述食安员管理平台提供 Webservice
4、接口应用服务，供各接入系统访问调用。在调用时，需按照本文档规定格式拼装参数，传入参数调用平台端 webservice 接口，接收 webservice 接口获取返回信息。各接入系统将返回信息进行解析后供自身系统处理使用。2 适 用 范 围本文档主要用于描述 Webservice 接口的定义、调用说明。文档可供接入食安员管理平台的各系统建设方、开发方阅读及使用。3 接 口 架 构3.1 接 口 逻 辑 架 构监考实时监控接口省食安员管理平台实时业务验证串接口签到登记人脸核验信息接口分配座位信息接口上机考试人脸核验接口考试间监控接口 、 考场监控接口业务处理接口考试机构信息接口监考员信息接口考场信
5、息接口考试科目信息接口互联网实时业务验证串培训考试机构接口机构调用数据上传机构调用数据上传机构调用数据上传机构调用数据上传机构轮询调用数据上传考试报名信息接口考试支付信息接口签到登记人脸核验信息接口分配座位信息接口上机考试人脸核验接口考试间监控接口 、 考场监控接口考试机构信息接口监考员信息接口考场信息接口考试科目信息接口考试报名信息接口考试支付信息接口业务管理接口机构调用上传在接口逻辑架构中，培训考试机构需要调用省平台的实时监控业务广东省食安员综合监管平台 Version: 1.0.0接口规范文档 Date: 2017-11-24Page: 6 of 39接口需要附带省平台的业务识别串。该串
6、为加密串，目的是保证考试机构在监考流程中的业务实时性，包含业务类型、业务时间、机构代码等。通过对加密串的分析，可以鉴别考试机构是否按照省平台的要求对考试过程进行实时监控。3.2 实 时 监 控 流 程1 签到验证身份证相片人脸核验相片签到登记信息2 分配座位分配座位信息省平台业务串3 上机考试核验人脸核验相片上机考试信息4 考试过程监控监控图片监控信息实时考场视频接入省视频监控平台培训考试机构和省平台实时上传数据流程省平台业务串省平台业务串 省平台业务串实时视频影像0 监考业务 机构信息 考场信息 考试科目 考试报名4 接 口 概 述4.1 接 口 概 述食安员管理平台作为服务端，以 WebS
7、ervice 方式为各个第三方系统等提供接口服务。接口采用 SOAP 协议，请求方在请求时以 base64 加密入参，服务器解密处理，返回 base64 加密回参，请求端自行解密使用。WebService 接口统一入口方法为 CallFun，通过 method 参数进行业务区分。4.2 数 据 类 型 与 格 式如无特殊说明，本文档中的部分数据均为以下格式： 日期： YYYY-MM-DD，即 4 位年，2 位月份，2 位日期。数据类型记为DATE，长度为 10。 时间：HH：MM:SS ，即 2 位小时（24 小时制），2 为分钟，2 为秒。数广东省食安员综合监管平台 Version: 1.0
8、.0接口规范文档 Date: 2017-11-24Page: 7 of 39据类型记为 TIME，长度为 6. 日期时间：YYYY-MM-DD HH：MM:SS。数据类型记为 DATETIME，长度为 19. 带毫秒日期时间：YYYY-MM-DD HH：MM：SS：FFF。FFF 为毫秒数。数据类型记为 DATETIME，长度为 17。 金额：DDDDDDDD.DD，整数部分最多为 8 位，小数点 1 位，小数部分为 2 位，若小数部分为 0，则小数点和小数部分可以省略。计量单位为人民币元。数据类型记为 DECIMAL，最大长度为 11。 单价：DDDDDDDD.DD,，整数部分最多为 8 位
9、，小数点 1 位，小数部分最多为 2 位，若小数部分为 0，则小数点和小数部分可以省略。计量单位为人民币元。数据类型记为 DECIMAL，最大长度为 11。 数量：DDDDDDDD.DD，8 位整数，2 为小数。小数部分为 0，小数点和小数部分可以省略，最大长度 11 位。数据类型记为 QUANTITY。 其他数据请参照数据字典。4.3 接 口 参 数 格 式4.3.1 请求参数请求参数为标准 XML 字符串，顶层节点名称为 Request，其下节点包括头部 Header 及数据 Body 两部分，具体格式如下：应 用 KEY请 求 方 法 接 口 方 法 版 本 参 数 签 名 请 求 时
10、间 流 水 号 广东省食安员综合监管平台 Version: 1.0.0接口规范文档 Date: 2017-11-24Page: 8 of 39标签名 数据类型中文名称 必填项 说明appCode String 请求应用的Code是 接入方应用分配的应用 CodesessionId String 会话 ID 或者Token是method String 请求的方法 是version String 接口版本 否sign String 参数签名 否reqTime String 请求时间戳 是reqTraceNo String 流水号 是4.3.2 响应参数响应参数为标准 Xml 字符串，顶层节点名称为
11、 Response，其下节点包括头部Header 节点及响应数据 Body 两部分，具体格式如下：结 果 值 编 码 结 果 描 述 结 果 详 细 描 述 广东省食安员综合监管平台 Version: 1.0.0接口规范文档 Date: 2017-11-24Page: 9 of 39标签名 数据类型 中文名称 必填项 说明code String 结果值编码 是 见字典（提示信息）msg String 结果消息 否 见字典（提示信息）detail String 结果详细描述 否 结果详细描述，错误时可以提供respTime DateTime 响应时间 是 格式:yyyy-mm-dd HH：mm：
12、ss 备注当响应参数包括多个子项时，子项内容父节点为 items，各子项内容节点为item。头 部 公 共 响 应 参 数 .广东省食安员综合监管平台 Version: 1.0.0接口规范文档 Date: 2017-11-24Page: 10 of 394.4 接 口 访 问 地 址http:/120.76.223.229:1080/sayifpf/webService/FdaWsOutsideEntrance?wsdl 5 接 口 详 细 参 数 和 格 式5.1 系 统 管 理5.1.1 系统通知消息字段名 CODE 类型 说明接口输入参数消息标题 TITLE_ varchar(64)发送时间 SEND_TIME_ datetime 范围值接受者 RECVER_ varchar(40)数字签名 SIGN_ varchar(255)接口返回参数ID ID_ varchar(40)消息类型 TYPE_ varchar(64)消息引用 REF_ varchar(40)消息标题 TITLE_ varchar(64)消息内容 CONTENT_ varchar(512)发送时间 SEND_TIME_ datetime发送者 SENDER_ varchar(40)5.2 省 平 台 业 务 验 证 串
