企业数据采集接口规范

广东省食品药品监督管理局 国家电子监管系统省局端系统 企业数据采集接口规范 建设单位： 广东省食品药品监督管理局 监理单位： 广州市信佰信息技术咨询有限公司 承建单位： 深圳市天驰医药信息技术开发有限公司 2012 年 12 月 12 日 修改情况记录： 版本号 修改批准人 修改人 修改日期 签收人 广东省食品药品监督管理局国家电子监管系统省局端系统， 企业数据采集接口规范 深圳市天驰医药信息技术开发有限公司，2012 第 3 页 共 24 页 目录 1. 概述 4 1.1. 接口内容 4 1.2. 实现方式 4 1.3. 安全控制 4 2. 术语与缩写解释 4 3. 系统入口 5 4. 接口详细说明 5 4.1. 接口功能列表 5 4.2. 响应数据格式公共约定 5 4.3. 下载经营品种库 7 4.4. 下载往来企业库 10 4.5. 上传文件 12 4.6. 下载文件处理情况 14 附录一 企业上传 xml 数据文件格式 .15 库存记录 16 不合格药品记录 17 生产入库 18 采购入库 19 批发退货入库 20 零售退货入库 22 批发出库 23 零售出库 24 退货出库 26 毁损出库 27 抽检出库 29 附录二 xml 数字签名 30 附录三 附件说明 32 1. 概述 本文档描述广东省食品药品监督管理局国家电子监管系统省局端系统平台与广东省 内药品流通相关企业内部系统之间的接口规范。 1.1.接口内容 提供企业经营品种库药品标准数据及其更新信息下载； 提供企业往来企业库企业标准数据及其更新信息下载； 接收企业上传已数字签名 xml 格式数据文件； 提供企业上传文件处理情况。 1.2.实现方式 标准 HTTPS GET/POST。 1.3.安全控制 要求客户端数字证书以实现服务器端与客户端双向身份验证。 备注：目前仅支持网证通数字证书，且必须在药监局已备案。 2. 术语与缩写解释 缩写、术语 解 释 药品标准数据 以药品本位码及包装规格联合作为唯一标识，并包含药品通用名、 剂型、规格、计量单位、生产企业名称属性,用于规范药品信息。 企业标准数据 以企业名称为唯一标识，并包含企业类型、所属地区、详细地址 属性，用于规范企业信息。 企业经营品种库 与企业生产经营相关的药品标准数据集，企业可通过在企业网上 办事平台手工设置、企业数据采集接口上传数据文件自动设置方式 配置本企业经营品种库。 企业往来企业库 企业的上游供货商或下游采购商企业标准数据集，企业可通过在 企业网上办事平台手工设置、企业数据采集接口上传数据文件自动 设置方式配置本企业往来企业库。 广东省食品药品监督管理局国家电子监管系统省局端系统， 企业数据采集接口规范 深圳市天驰医药信息技术开发有限公司，2012 第 5 页 共 24 页 3. 系统入口 服务器 IP 及端口号如下，完整连接请参照具体接口功能请求路径模板 测试服务器入口： 生产服务器入口： 部署调整中，请联系技术支持人员。 4. 接口详细说明 4.1.接口功能列表 请求路径模板： https:/服务器 IP 及端口号/data/ clientAccept/请求入口 功能名称 请求入口 描述 下载经营品种库 toOperationCommodity.do 获取经营品种库药品标准数据及药品标准数据 更新信息。 下载往来企业库 toContactsBusiness.do 获取往来企业库企业标准数据及企业标准数据 更新信息。 上传文件 toUploadFile.do 上传已数字签名 XML 格式数据文件。 下载文件处理情况 toDowloadFileDeal.do 获取已上传数据文件处理情况。 4.2.响应数据格式公共约定 描述所有功能或特定类别的响应数据格式模板，具体功能响应描述部分不再重复介绍 本部分已定义数据格式。 4.2.1. 通用数据格式 所有响应数据的共有格式。 字段代码 字段名称 数据类型 可为 null 备注 resultCode 操作状态代码 整数 否 请求操作执行状态 0 请求操作处理成 功； 1 身份验证失败， 数字证书无效或未 关联企业； 2 系统繁忙； 3 数据验证失败， 缺少必须的请求参 数或请求参数值无 效。 resultText 操作状态描述 文本 否 对操作结果的补充 说明。操作成功为 空。 data 返回结果 集合/对象/具体 值 是 请求操作的实际响 应结果，根据具体 功能有不同定义。 resultCode=0 时设 置。 详见各功能响应说 明。 JSON 格式响应示例： “data“:“,“resultCode“:0,“resultText“:“ XML 格式响应示例： 0 4.2.2. 分页响应数据格式 返回结果集合的响应数据的特定格式。 字段代码 字段名称 数据类型 可为 null 备注 data 结果数据集合 集合 结果数据的集合，结果数 据如：药品标准数据、企 业标准数据。 dataId 数据增量标识 整数 否 下次请求时必选参数，仅 用于标识结果数据增量信 息。 pageCount 最大记录数 整数 否 结果数据集合data中最 大可能数据记录数量。 广东省食品药品监督管理局国家电子监管系统省局端系统， 企业数据采集接口规范 深圳市天驰医药信息技术开发有限公司，2012 第 7 页 共 24 页 total 结果数据记录数 整数 否 结果数据集合data中当 前实际数据记录数量。如 果 total = pageCount 表 示需继续获取数据。 JSON 格式响应示例蓝色字体部分： “data“: “data“: , , “dataId“:“403“, “pageCount“:100, “total“:2 , “resultCode“:0, “resultText“:“ XML 格式响应示例蓝色字体部分： 0 2 100 0 4.3.下载经营品种库 企业端调用此接口功能以实现企业内部药品信息与药监药品标准信息的一致性。 本功能仅提供药监系统中，企业已维护的本企业经营品种库范围内的药品标准信息及 其更新信息。 4.3.1. 接入 URL https:/服务器 IP 及端口号/data/clientAccept/ toOperationCommodity.do 4.3.2. 接入方式 POST/GET 4.3.3. 请求 参数名称 是否必须 描述 dataId 是 药品数据增量标识。用于限制药品数据获取范围，第一次 请求 dataId 可为 0； 下一次请求的 dataId 从响应结果中 的 dataId 中获取。 resType 否 响应数据格式。可选值为：xml 或 json;不设置本参数， 缺省响应格式为 json。 请求示例： https:/test20120401- 1:8081/data/clientAccept/toOperationCommodity.do?dataId=0不设置本参数， 缺省响应格式为 json。 广东省食品药品监督管理局国家电子监管系统省局端系统， 企业数据采集接口规范 深圳市天驰医药信息技术开发有限公司，2012 第 11 页 共 24 页 请求示例： https:/test20120401- 1:8081/data/clientAccept/toContactsBusiness.do?dataId=0不设置本参数， 缺省响应格式为 json。 请求示例： HTML 格式请求表单源码： 4.5.4. 响应 本功能响应格式为简单通用数据格式。 响应结果描述示例中蓝色字体部分 ： 字段代码 字段名称 数据类型 可为 null 备注 data 文件标识 整数 否 成功上传文件后设置，用 于下载文件处理情况功能。 JSON 格式响应示例： “data“:“622“,“resultCode“:0,“resultText“:“ XML 格式响应示例： 0 622 4.6.下载文件处理情况 基于服务器端并发性能考虑，企业上传的文件不实时处理并反馈处理结果。文件上传 成功时，系统仅反馈文件唯一标识。经过一个固定的周期，系统后台服务处理完成后，企 业端可依据该唯一标识从服务器获取文件处理情况。 4.6.1. 接入 URL https:/服务器 IP 及端口号/data/clientAccept/toDowloadFileDeal.do 4.6.2. 接入方式 POST/GET 4.6.3. 请求 参数名称 是否必须 描述 fid 是 文件唯一标识，上传文件操作响应中的 data。 resType 否 响应数据格式。可选值为：xml 或 json;不设置本参数， 缺省响应格式为 json。 请求示例： https:/test20120401- 1:8081/data/clientAccept/toDowloadFileDeal.do?fid=622&resType=xml 广东省食品药品监督管理局国家电子监管系统省局端系统， 企业数据采集接口规范 深圳市天驰医药信息技术开发有限公司，2012 第 15 页 共 24 页 4.6.4. 响应 本功能响应格式为通用数据格式。 响应结果对象描述示例中蓝色字体部分 ： 字段代码 字段名称 数据类型 可为 null 备注 fileId 文件标识 整数 否 dealStatus 处理状态 整数 否 文件处理状态 0 未处理； 1 已经处理。 该值为 0，后续字段无意 义 dealResult 处理结果代码 整数 是 文件处理结果 0：文件解析或数字签名验 证失败，需解决错误问题 后重新上传； 1：文件处理成功，已生成 正确业务单据； 2：文件中药品或企业数据 标准化验证失败，已生成 业务单据，需登录企业网 上办事平台手工修正。 dealDesc 处理结果描述 文本 是 dealResult 不为 1 时，附加 错误提示。 dealTime 处理时间 时间 是 other 补充说明 文本 是 JSON 格式响应示例： “data“: “dealDesc“:“,“dealResult“:“,“dealStatus“:“0“,“dealTime“:“,“fileId“:“622“,“other“:“, “resultCode“:0, “resultText“:“ XML 格式响应示例： 0 622 0 附录一 企业上传 xml 数据文件格式 企业数据采集接口接收的 xml 数据文件分为库存记录、不合格药品记录、生产入库、 采购入库、批发退货入库、零售退货入库、批发出库、零售出库、退货出库、毁损出库、 抽检出库这 11 种业务类型。 重点提示： 各业务类型表单或明细条目属性描述中标记为标准化数据字段 的属性，表示应为药品标准数据或企业标准数据唯一标识。 各业务类型 xml 数据文件中根节点 xmlns 属性值最后部分为对应 xml 架构文件名称，可从本文档同一目录下的“xml 架构”子目录 获取对应的 xml 架构文件。 库存记录 xsd 架构文件名称：yjj_qyjk_kc.xsd 表单属性说明： 代码 名称 数据类型 约束/限制 是否必填 pdsj 库存盘点截至日期 日期 不能晚于系统当前日期 是 明细条目属性说明： 代码 名称 数据类型 约束/限制 是否必填 bwm 本位码 文本 长度 14标准化数据字段 是 bzgg 包装规格 文本 长度 200标准化数据字段 是 scph 生产批号 文本 长度 50 是 scrq 生产日期 日期 不能晚于系统当前日期 是 yxqz 有效期至 日期 大于生产日期 是 kcsl 库存数量 整数 大于 0 是 广东省食品药品监督管理局国家电子监管系统省局端系统， 企业数据采集接口规范 深圳市天驰医药信息技术开发有限公司，2012 第 17 页 共 24 页 bz 备注 文本 长度 200 否 不合格药品记录 xsd 架构文件名称：yjj_qyjk_bhg.xsd 明细条目属性说明： 代码 名称 数据类型 约束/限制 是否必填 bwm 本位码 文本 长度 14标准化数据字段 是 bzgg 包装规格 文本 长度 200标准化数据字段 是 scph 生产批号 文本 长度 50 是 scrq 生产日期 日期 不能晚于系统当前日期 是 yxqz 有效期至 日期 大于生成日期 是 sl 不合格数量 整数 大于 0 是 yy 不合格原因 文本 长度 50 是 sfcl 是否已处理 布尔 True/False 是 clfs 处理方式 文本 长度 50 否 clrq 处理日期 日期 否 bz 备注 文本 长度 200 否 生产入库 xsd架构文件名称：yjj_qyjk_scrk.xsd 表单属性说明： 代码 名称 数据类型 约束/限制 是否必填 djbh 入库单号 文本 长度 50 是 rqrq 入库日期 日期 不能晚于系统当前日期 是 clr 处理人 文本 长度 20 否 明细条目属性说明： 代码 名称 数据类型 约束/限制 是否必填 bwm 本位码 文本 长度 14标准化数据字段 是 bzgg 包装规格 文本 长度 200标准化数据字段 是 scph 生产批号 文本 长度 50 是 scrq 生产日期 日期 不能晚于系统当前日期 是 yxqz 有效期至 日期 大于生成日期 是 sl 数量 整数 大于 0 是 bz 备注 文本 长度 200 否 采购入库 xsd 架构文件名称：yjj_qyjk_cgrk.xsd 表单属性说明： 代码 名称 数据类型 约束/限制 是否必填 djbh 入库单号（采购方 入库单号） 文本 长度 50 是 rqrq 购进日期 日期 不能晚于系统当前日期 是 ghqy 供货企业名称 文本 长度 200标准化数据字段 是 xsdh 销售单号（供货方 随货单号） 文本 长度 50 是 yssb 运输设备 文本 长度 100 否 yskssj 运输开始时间 时间 否 ysjssj 运输结束时间 时间 否 wdjl 温度记录 文本 长度 100 否 clr 验收员名称 文本 长度 20 是 ysjl 购进结论 文本 长度 30 是 明细条目属性说明： 代码 名称 数据类型 约束/限制 是否必填 bwm 本位码 文本 长度 14标准化数据字段 是 bzgg 包装规格 文本 长度 200标准化数据字段 是 scph 生产批号 文本 长度 50 是 scrq 生产日期 日期 不能晚于系统当前日期 是 yxqz 有效期至 日期 大于生成日期 是 sl 采购数量 整数 大于 0 是 bz 备注 文本 长度 200 否 批发退货入库 xsd 架构文件名称：yjj_qyjk_pfthrk.xsd 表单属性说明： 代码 名称 数据类型 约束/限制 是否必填 djbh 入库单号 文本 长度 50 是 rqrq 退货日期 日期 不能晚于系统当前日期 是 thqy 退货企业名称 文本 长度 200标准化数据字段 是 yssb 运输设备 文本 长度 100 否 yskssj 运输开始时间 时间 否 ysjssj 运输结束时间 时间 否 广东省食品药品监督管理局国家电子监管系统省局端系统， 企业数据采集接口规范 深圳市天驰医药信息技术开发有限公司，2012 第 19 页 共 24 页 wdjl 温度记录 文本 长度 100 否 clr 验收员名称 文本 长度 20 是 ysjl 验收结论 文本 长度 30 是 明细条目属性说明： 代码 名称 数据类型 约束/限制 是否必填 bwm 本位码 文本 长度 14标准化数据字段 是 bzgg 包装规格 文本 长度 200标准化数据字段 是 scph 生产批号 文本 长度 50 是 scrq 生产日期 日期 不能晚于系统当前日期 是 yxqz 有效期至 日期 大于生成日期 是 sl 退货数量 整数 大于 0 是 yy 退货原因 文本 长度 50 是 xsdh 销售单号 文本 长度 50 是 bz 备注 文本 长度 200 否 零售退货入库 xsd 架构文件名称：yjj_qyjk_lsthrk.xsd 表单属性说明： 代码 名称 数据类型 约束/限制 是否必填 djbh 入库单号 文本 长度 50 是 rqrq 退货日期 日期 不能晚于系统当前日期 是 clr 处理人 文本 长度 20 否 明细条目属性说明： 代码 名称 数据类型 约束/限制 是否必填 bwm 本位码 文本 长度 14标准化数据字段 是 bzgg 包装规格 文本 长度 200标准化数据字段 是 scph 生产批号 文本 长度 50 是 scrq 生产日期 日期 不能晚于系统当前日期 是 yxqz 有效期至 日期 大于生成日期 是 sl 退货数量 整数 大于 0 是 yy 退货原因 文本 长度 50 是 xsdh 销售单号 文本 长度 50 否 bz 备注 文本 长度 200 否 批发出库 xsd 架构文件名称：yjj_qyjk_pfck.xsd 表单属性说明： 代码 名称 数据类型 约束/限制 是否必填 djbh 销售单号 文本 长度 50 是 ckrq 销售日期 日期 不能晚于系统当前日期 是 cgqy 采购企业名称 文本 长度 200标准化数据字段 是 clr 销售员 文本 长度 20 否 ysfs 运输方式 文本 长度 100 否 cyr 承运人 文本 长度 200 否 yskssj 运输开始时间 时间 否 ysjssj 运输结束时间 时间 否 qywd 起运温度 文本 长度 20 单位:摄氏度 否 ddwd 到达温度 文本 长度 20 单位:摄氏度 否 明细条目属性说明： 代码 名称 数据类型 约束/限制 是否必填 bwm 本位码 文本 长度 14标准化数据字段 是 bzgg 包装规格 文本 长度 200标准化数据字段 是 scph 生产批号 文本 长度 50 是 scrq 生产日期 日期 不能晚于系统当前日期 是 yxqz 有效期至 日期 大于生成日期 是 sl 销售数量 整数 大于 0 是 bz 备注 文本 长度 200 否 零售出库 xsd 架构文件名称：yjj_qyjk_lsck.xsd 表单属性说明： 代码 名称 数据类型 约束/限制 是否必填 djbh 销售单号 文本 长度 50 是 ckrq 销售日期 日期 不能晚于系统当前日期 是 clr 销售员 文本 长度 20 否 明细条目属性说明： 代码 名称 数据类型 约束/限制 是否必填 bwm 本位码 文本 长度 14标准化数据字段 是 广东省食品药品监督管理局国家电子监管系统省局端系统， 企业数据采集接口规范 深圳市天驰医药信息技术开发有限公司，2012 第 21 页 共 24 页 bzgg 包装规格 文本 长度 200标准化数据字段 是 scph 生产批号 文本 长度 50 是 scrq 生产日期 日期 不能晚于系统当前日期 是 yxqz 有效期至 日期 大于生成日期 是 sl 销售数量 整数 大于 0 是 bz 备注 文本 长度 200 否 退货出库 xsd 架构文件名称：yjj_qyjk_thck.xsd 表单属性说明： 代码 名称 数据类型 约束/限制 是否必填 djbh 出库单号 文本 长度 50 是 ckrq 退货日期 日期 不能晚于系统当前日期 是 ghqy 供货企业名称 文本 长度 200标准化数据字段 是 clr 处理人 文本 长度 20 否 ysfs 运输方式 文本 长度 100 否 cyr 承运人 文本 长度 200 否 yskssj 运输开始时间 时间 否 ysjssj 运输结束时间 时间 否 qywd 起运温度 文本 长度 20 单位:摄氏度 否 ddwd 到达温度 文本 长度 20 单位:摄氏度 否 明细条目属性说明： 代码 名称 数据类型 约束/限制 是否必填 bwm 本位码 文本 长度 14标准化数据字段 是 bzgg 包装规格 文本 长度 200标准化数据字段 是 scph 生产批号 文本 长度 50 是 scrq 生产日期 日期 不能晚于系统当前日期 是 yxqz 有效期至 日期 大于生成日期 是 sl 退货数量 整数 大于 0 是 yy 退货原因 文本 长度 50 否 xsdh 销售单号（供货企 业随货单号） 文本 长度 50 是 bz 备注 文本 长度 200 否 毁损出库 xsd 架构文件名称：yjj_qyjk_hsck.xsd 表单属性说明： 代码 名称 数据类型 约束/限制 是否必填 djbh 出库单号 文本 长度 50 是 ckrq 出库日期 日期 不能晚于系统当前日期 是 clr 处理人 文本 长度 20 否 明细条目属性说明： 代码 名称 数据类型 约束/限制 是否必填 bwm 本位码 文本 长度 14标准化数据字段 是 bzgg 包装规格 文本 长度 200标准化数据字段 是 scph 生产批号 文本 长度 50 是 scrq 生产日期 日期 不能晚于系统当前日期 是 yxqz 有效期至 日期 大于生成日期 是 sl 毁损数量 整数 大于 0 是 yy 毁损原因 文本 长度 50 否 ghqy 供货企业名称 文本 长度 200 否 xsdh 销售单号 文本 长度 50 否 bz 备注 文本 长度 200 否 抽检出库 xsd 架构文件名称：yjj_qyjk_cjck.xsd 表单属性说明： 代码 名称 数据类型 约束/限制 是否必填 djbh 出库单号 文本 长度 50 是 ckrq 出库日期 日期 不能晚于系统当前日期 是 cjdw 抽检单位名称 文本 长度 200 否 cjyy 抽检原因 文本 长度 200 否 clr 处理人 文本 长度 20 否 明细条目属性说明： 代码 名称 数据类型 约束/限制 是否必填 bwm 本位码 文本 长度 14标准化数据字段 是 bzgg 包装规格 文本 长度 200标准化数据字段 是 scph 生产批号 文本 长度 50 是 scrq 生产日期 日期 不能晚于系统当前日期 是 yxqz 有效期至 日期 大于生成日期 是 kcsl 库存数量 整数 大于 0 否 cjsl 抽检数量 整数 大于 0 是 bz 备注 文本 长度 200 否 广东省食品药品监督管理局国家电子监管系统省局端系统， 企业数据采集接口规范 深圳市天驰医药信息技术开发有限公司，2012 第 23 页 共 24 页 附录二 xml 数字签名 为保障企业上报数据的安全，便于确认企业上报原始文档未被修改，企业通过“企业 数据采集接口”上报的 xml 文件必须经过数字签名。 本接口可接受的 xml 文件数字签名遵循 W3C 推荐规范 - XML 签名的语法和处理规范 XML-Signature Syntax and Processing W3C Recommendation 12 February 2002。 补充约定如下： 采用封装签名（Enveloping）格式，签名和原始 xml 文件内容在同一个 XML 文 档中，原始 xml 文件内容作为签名的内部节点； 签名文件必须附带数字证书信息,签名文件中证书信息相关部分必须设置，且按如 下所示指定顺序提供 /。 示例: pHdUADSXDNMmM7py0zuNlx6gQKE= Ym9uW9ePzi1f0F6vMtTMIpiUC2gNI0o2X8gYvF7yiuXLtUPqN4G 1yavil/VTrbFvPxpfEZkdlxL7PU+9oYie4k4pF+fbQhxbkSr5v81t+JHtt37evQyTvWi+8g i7kU/ZbjpF4Msk7PuwrDUOez1e6bWBBvyIvet6UfMN3YXP92U= CN=NETCA Individual ClassA CA, OU=Individual ClassA CA, O=NETCA Certificate Authority, C=CN 53721960771501034418789216508892913400 MIID9zCCAt+gAwIBAgIQKGp5KavX8ujDBgo/bvee+D ANBgkqhkiG9w0BAQUFADB3MQswCQYDVQQGEwJDTjEkMCIGA1UEChM bTkVUQ0EgQ2VydGlmaWNhdGUgQXV0aG9yaXR5MR0wGwYDVQQLExRJb mRpdmlkdWFsIENsYXNzQSBDQTEjMCEGA1UEAxMaTkVUQ0EgSW5kaXZ pZHVhbCBDbGFzc0EgQ0EwHhcNMTIwNDE4MTYwMDAwWhcNMTMwND E5MTU1OTU5WjBkMQswCQYDVQQGEwJDTjESMBAGA1UECBMJR3Vhbm dkb25nMSUwIwYDVQQDHhxOKk66bUuL1QAyADAAMQAxADAANAAyAD IAMQA2MRowGA