数据字典系统接口文档.docxVIP

数据字典接口文档 数据字典接口文档 版本修订信息 数据字典接口文档 （V0.0.1 ） 2015 年 6 月 版本号 完成日期 拟稿和修改人 发布日期 变更说明 V1.0.0 新建文档 目录 TOC \o 1-5 \h \z \o Current Document 文档说明 4 \o Current Document 功能描述 4 \o Current Document 阅读对象 4 \o Current Document 业务术语 4 \o Current Document ERP系统开发准备 4 \o Current Document 技术资料获取及准备 4 \o Current Document 确认调用系统信息 4 \o Current Document 环境搭建 5 \o Current Document 数据字典接口调用流程 5 \o Current Document 数据字典接口调用流程图 5 \o Current Document 数据字典接口调用步骤 5 \o Current Document 构造请求数据 5 \o Current Document 发送请求数据 6 请求字符集设置 错误！未定义书签。 \o Current Document 数据字典系统对请求数据进行处理 6 \o Current Document 返回处理的结果数据 6 \o Current Document 接口说明 6 获取数据字典生效 KEY 错误！未定义书签。 请求参数列表 错误！未定义书签。 应答参数 错误！未定义书签。 使用举例 错误！未定义书签。 TOC \o 1-5 \h \z \o Current Document 常见问题及注意事项 10 \o Current Document 调用方式 10 页面组件使用 错误！未定义书签。 \o Current Document 附录 10 \o Current Document 请求响应码 10 \o Current Document 数据字典系统 KEY列表 11 1 文档说明 1.1 功能描述 本文档从技术角度描述了使用字典系统的字典数据的使用方法， 进而指导系统开发者与 数据字典系统的对接。 1.2 阅读对象 本文档是面向具有一定开发能力的开发者。 1.3 业务术语 术语 解释 字典类目 类似字典的分类 分组描述。 字典项 具体使用的字典数据 包括编码 名称和值。 字典关联配置 配置两个字典类目间字典项的关联 2 ERP系统开发准备 技术资料获取及准备 2.1.1 确认调用系统信息 确认要调用的接口，以及对应数据项的 KEY。 确系统使用的编码格式为 UTF-8 。 确认拿到的是接口资料为要使用的版本 2.2 环境搭建 本机电脑的调试环境 开发工具： Eclipse 或 Myeclipse 等； 编辑工具： EditPlus 、NotePad++、电脑自带的“记事本”等 环境配置：使用 JAVA开发需要 JAVA的环境配置。 使用其他语言开发需要配 置相对该语言的环境。 服务器的调试环境 硬件方面：由于网上支付平台提供的软件同商户的系统紧密集成， 通常不需 要额外的硬件投资。 软件方面： java 语言的 JDK1.5或以上，操作系统不限，服务器需要支持各 开发语言对应的环境， 如果是 pom工程 需要引入： dependency groupIdcom.caissa.erp/groupId artifactIddict/artifactId version0.0.1/version /dependency 备注：版本号可能会随着系统升级发生变化，以接入时的系统给出的为准。 数据字典接口调用流程 数据字典接口调用流程图 数据字典接口调用步骤 3.2.1 构造请求数据 系统开发人员根据要需求确认要请求的接口，以及接口的主要数据，主要包 括：接口的方法，接口的参数值。 (1) 请求参数如下： 将请求参数拼装成请求对象后， 3.2.2 发送请求数据 接口交互方式为： dubbo。 服务注册中心 zookeeper 地址如下： 生产环境地址： 测试环境地址： 3.2.3 数据字典系统对请求数据进行处理 3.2.4 返回处理的结果数据 接口说明 为了方便接口的统一管理，以下接口都需要基于基础请求和基础应答 基础请求参数 参数 参数名称 类型 长度 必填 参数说明 version 版本号 字符串 16 是 Version=0.0.1 method 接口编码 字符串 64 是 reqSysCode 请