广东食安员综合监管平台.DOC

1、 广东省食安员综合监管平台 接口规范文档 V1.0 2017-11 广东省食安员综合监管平台 Version: 1.0.0 接口规范文档 Date: 2017-11-24 Page: 2 of 39 改版记录 版本 发布日期 描述 作者 复审 批准 1.0 2017/11/24 建立该文档 ,初稿 变更记录 变更编号 日期 变更项 描述 基线版本 变更请求编号 广东省食安员综合监管平台 Version: 1.0.0 接口规范文档 Date: 2017-11-24 Page: 3 of 39 目录 1 文档 概述 .5 2 适用范围 .5 3 接口架构 .5 3.1 接口逻辑架构 .5 3.2

2、实时监控流程 .6 4 接口概述 .6 4.1 接口概述 .6 4.2 数据类型与格式 .6 4.3 接口参数格式 .7 4.3.1 请求参数 .7 4.3.2 响应参数 .8 4.4 接口访问地址 . 10 5 接口详细参数和格式 . 10 5.1 系统管理 . 10 5.1.1 系统通知消息 . 10 5.2 省平台业务验证串 . 10 5.2.1 数字签名生成功能接口 . 11 5.3 食安平台考试培训管理接口 . 12 5.3.1 业务机构登记接口 . 12 5.3.2 培训师登记 . 14 5.3.3 食 安学员培训报名 . 17 5.3.4 考场登记 . 19 5.3.5 考场座位

3、安排 . 21 5.3.6 考试科目登记 . 23 5.3.7 食安培训课程开设 . 25 5.3.8 培训师授课安排 . 27 广东省食安员综合监管平台 Version: 1.0.0 接口规范文档 Date: 2017-11-24 Page: 4 of 39 5.4 食安平台考试培训监控接口 . 29 5.4.1 食安员考试签到认证 . 30 5.4.2 食安员上机考试核验 . 32 5.4.3 考生考试过程监控接口 . 34 5.4.4 考场监控设备实时视频接口 . 36 6 附录：字典 . 38 6.1 接口功能编号 . 38 广东省食安员综合监管平台 Version: 1.0.0 接口

4、规范文档 Date: 2017-11-24 Page: 5 of 39 食安员管理平台 接口设计文档 1 文档 概述 食安员管理平台提供 Webservice 接口应用服务，供各接入系统访问调用。在调用时，需按照本文档规定格式拼装参数，传入参数调用平台端 webservice 接口，接收 webservice 接口获取返回信息。各接入系统将返回信息进行解析后供自身系统处理使用 。 2 适用范围 本文档主要用于描述 Webservice 接口的定义、调用说明。文档可供接入食安员管理平台的各系统建设方、开发方阅读及使用。 3 接口架构 3.1 接口逻辑架构 监 考 实 时 监 控 接 口省 食 安

5、 员 管 理 平 台实 时 业 务 验 证 串 接 口签 到 登 记 人 脸 核 验 信 息接 口分 配 座 位 信 息 接 口上 机 考 试 人 脸 核 验 接 口考 试 间 监 控 接 口 、 考 场监 控 接 口业 务 处 理 接 口考 试 机 构 信 息 接 口监 考 员 信 息 接 口考 场 信 息 接 口考 试 科 目 信 息 接 口互 联 网实 时 业 务 验 证 串培 训 考 试 机 构 接 口机 构 调 用 数 据 上 传机 构 调 用 数 据 上 传机 构 调 用 数 据 上 传机 构 调 用 数 据 上 传机 构 轮 询 调 用 数 据 上 传考 试 报 名 信 息 接

6、口考 试 支 付 信 息 接 口签 到 登 记 人 脸 核 验 信 息接 口分 配 座 位 信 息 接 口上 机 考 试 人 脸 核 验 接 口考 试 间 监 控 接 口 、 考 场监 控 接 口考 试 机 构 信 息 接 口监 考 员 信 息 接 口考 场 信 息 接 口考 试 科 目 信 息 接 口考 试 报 名 信 息 接 口考 试 支 付 信 息 接 口业 务 管 理 接 口机 构 调 用 上 传在接口逻辑架构中，培训考试机构需要调用省平台的实时监控业务广东省食安员综合监管平台 Version: 1.0.0 接口规范文档 Date: 2017-11-24 Page: 6 of 39 接

7、口需要附带省平台的业务识别串。该串为加密串，目的是保证考试机构在监考流程中的业务实时性，包含业务类型、业务时间、机构代码等。通过对加密串的分析，可以鉴别考试机构是否按照省平台的要求对考试过程进行实时监控。 3.2 实时监控流程 1 签 到 验 证身 份 证 相 片人 脸 核 验 相 片签 到 登 记 信 息2 分 配 座 位分 配 座 位 信 息省 平 台 业 务 串3 上 机 考 试 核 验人 脸 核 验 相 片上 机 考 试 信 息4 考 试 过 程 监 控监 控 图 片监 控 信 息实 时 考 场 视 频接 入 省 视 频 监 控平 台培 训 考 试 机 构 和 省 平 台 实 时 上

8、传 数 据 流 程省 平 台 业 务 串省 平 台 业 务 串 省 平 台 业 务 串实 时 视 频 影 像0 监 考 业 务 机 构 信 息 考 场 信 息 考 试 科 目 考 试 报 名4 接口概述 4.1 接口概述 食安员管理平台作为服务端，以 WebService 方式为各个第三方系统等提供接 口服务。接口采用 SOAP 协议，请求方在请求时以 base64 加密入参，服务器解密处理，返回 base64 加密回参，请求端自行解密使用。 WebService 接口统一入口方法为 CallFun，通过 method 参数进行业务区分。 4.2 数据类型与格式 如无特殊说明，本文档中的部分数

9、据均为以下格式： 日期： YYYY-MM-DD，即 4 位年， 2 位月份， 2 位日期。数据类型记为DATE，长度为 10。 时间： HH： MM:SS，即 2 位小时（ 24 小时制）， 2 为分钟， 2 为秒。数据类型记为 TIME，长度为 6. 广东省食安员综合监管平台 Version: 1.0.0 接口规范文档 Date: 2017-11-24 Page: 7 of 39 日期时间： YYYY-MM-DD HH： MM:SS。数据类型记为 DATETIME，长度为 19. 带毫秒日期时间： YYYY-MM-DD HH： MM： SS： FFF。 FFF 为毫秒数。数据类型记为 DAT

10、ETIME，长度为 17。 金额： DDDDDDDD.DD，整数部分最多为 8 位，小数点 1 位，小数部分为2 位，若小数部分为 0，则小数点和小数部分可以省略。计量单位为人民币元。数据类型记为 DECIMAL，最大长度为 11。 单价： DDDDDDDD.DD,，整数部分最多为 8 位，小数点 1 位，小数部分最多为 2 位，若小数部分为 0，则小数点和小数部分可以省略。计量单 位为人民币元。数据类型记为 DECIMAL，最大长度为 11。 数量： DDDDDDDD.DD， 8 位整数， 2 为小数。小数部分为 0，小数点和小数部分可以省略，最大长度 11 位。数据类型记为 QUANTIT

11、Y。 其他数据请参照数据字典。 4.3 接口参数格式 4.3.1 请求参数 请求参数为标准 XML 字符串，顶层节点名称为 Request，其下节点包括头部 Header 及数据 Body 两部分，具体格式如下： 应用 KEY 请求方法 接口方法版本 参数签名 请求时间 流水号 广东省食安员综合监管平台 Version: 1.0.0 接口规范文档 Date: 2017-11-24 Page: 8 of 39 标签名 数据类型 中文名称 必填项 说明 appCode String 请求应用的Code 是 接入方应用分配的应用 Code sessionId String 会话 ID 或者Token

12、 是 method String 请求的方法 是 version String 接口版本 否 sign String 参数签名 否 reqTime String 请求时间戳 是 reqTraceNo String 流水号 是 4.3.2 响应参数 响应参数为标准 Xml 字符串，顶层节点名称为 Response，其下节点包括头部Header 节点及响应数据 Body 两部分，具体格式如下： 结果值编码 结果描述 结果详细描述 广东省食安员综合监管平台 Version: 1.0.0 接口规范文档 Date: 2017-11-24 Page: 9 of 39 标签名 数据类型 中文名称 必填项 说

13、明 code String 结果值编码 是 见字 典（提示信息） msg String 结果消息 否 见字典（提示信息） detail String 结果详细描述 否 结果详细描述，错误时可以提供 respTime DateTime 响应时间 是 格式 :yyyy-mm-dd HH： mm： ss 备注 当响应参数包括多个子项时，子项内容父节点为 items，各子项内容节点为 item。 头部公共响应参数 . 广东省食安员综合监管平台 Version: 1.0.0 接口规范文档 Date: 2017-11-24 Page: 10 of 39 4.4 接口访问地址 http:/120.76.22

14、3.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 省平台业务验证 串