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

广东省食安员综合监管平台 接口规范文档 2017-11 改版记录 版本 发布日期 描述 作者 复审 批准 1.0 2017/11/24 建立该文档,初稿 变更记录 变更编号 日期 变更项 描述 基线版本 变更请求编号 目录 1 文档概述 5 2 适用范围 5 3 接口架构 5 3.1 接口逻辑架构 5 3.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 数字签名生成功能接口 10 5.3 食安平台考试培训管理接口 12 5.3.1 业务机构登记接口 12 5.3.2 培训师登记 14 5.3.3 食安学员培训报名 17 5.3.4 考场登记 19 5.3.5 考场座位安排 21 5.3.6 考试科目登记 23 5.3.7 食安培训课程开设 25 5.3.8 培训师授课安排 27 5.4 食安平台考试培训监控接口 29 5.4.1 食安员考试签到认证 30 5.4.2 食安员上机考试核验 32 5.4.3 考生考试过程监控接口 34 5.4.4 考场监控设备实时视频接口 36 6 附录：字典 38 6.1 接口功能编号 38 食安员管理平台 接口设计文档 文档概述 食安员管理平台提供Webservice接口应用服务，供各接入系统访问调用。在调用时，需按照本文档规定格式拼装参数，传入参数调用平台端webservice接口，接收webservice接口获取返回信息。各接入系统将返回信息进行解析后供自身系统处理使用。 适用范围 本文档主要用于描述Webservice接口的定义、调用说明。文档可供接入食安员管理平台的各系统建设方、开发方阅读及使用。 接口架构 接口逻辑架构 在接口逻辑架构中，培训考试机构需要调用省平台的实时监控业务接口需要附带省平台的业务识别串。该串为加密串，目的是保证考试机构在监考流程中的业务实时性，包含业务类型、业务时间、机构代码等。通过对加密串的分析，可以鉴别考试机构是否按照省平台的要求对考试过程进行实时监控。 实时监控流程 接口概述 接口概述 食安员管理平台作为服务端，以WebService方式为各个第三方系统等提供接口服务。接口采用SOAP协议，请求方在请求时以base64加密入参，服务器解密处理，返回base64加密回参，请求端自行解密使用。 WebService接口统一入口方法为CallFun，通过method参数进行业务区分。 数据类型与格式 如无特殊说明，本文档中的部分数据均为以下格式： 日期： YYYY-MM-DD，即4位年，2位月份，2位日期。数据类型记为DATE，长度为10。 时间：HH：MM:SS，即2位小时（24小时制），2为分钟，2为秒。数据类型记为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位，小数点1位，小数部分最多为2位，若小数部分为0，则小数点和小数部分可以省略。计量单位为人民币元。数据类型记为DECIMAL，最大长度为11。 数量：DDDDDDDD.DD，8位整数，2为小数。小数部分为0，小数点和小数部分可以省略，最大长度11位。数据类型记为QUANTITY。 其他数据请参照数据字典。 接口参数格式 请求参数 请求参数为标准XML字符串，顶层节点名称为Request，其下节点包括头部Header及数据Body两部分，具体格式如下： request header appCode应用Key/appCode sessionId/sessionId method请求方法/method version接口方法版本/version sign参数签名/sign reqTime请求时间/reqTime r