数据字典系统接口文档

数据字典接口文档
（V0.0.1 ）
2015 年 6 月
版本修订信息
目录
1 文档说明 (4)
1.1 功能描述 (4)
1.2 阅读对象 (4)
1.3 业务术语 (4)
2 ERP系统开发准备 (4)
2.1 技术资料获取及准备 (4)
2.1.1 确认调用系统信息 (4)
2.2 环境搭建 (5)
3 数据字典接口调用流程 (5)
3.1 数据字典接口调用流程图 (5)
3.2 数据字典接口调用步骤 (5)
3.2.1 构造请求数据 (5)
3.2.2 发送请求数据 (6)
3.2.3 请求字符集设置 ................................ 错误！未定义书签。

3.2.4 数据字典系统对请求数据进行处理 (6)
3.2.5 返回处理的结果数据 (6)
4 接口说明 (6)
4.1 获取数据字典生效KEY ................................. 错误！未定义书签。

4.1.1 请求参数列表 .................................. 错误！未定义书签。

4.1.2 应答参数 ...................................... 错误！未定义书签。

4.1.3 使用举例 ...................................... 错误！未定义书签。

5 常见问题及注意事项 (10)
5.1 调用方式 (10)
5.2 页面组件使用...................................... 错误！未定义书签。

6 附录 (10)
6.1 请求响应码 (10)
6.2 数据字典系统KEY列表 (11)
1 文档说明
1.1 功能描述
本文档从技术角度描述了使用字典系统的字典数据的使用方法，进而指导系统开发者与数据字典系统的对接。

1.2 阅读对象
本文档是面向具有一定开发能力的开发者。

1.3 业务术语
2 ERP系统开发准备
2.1 技术资料获取及准备
2.1.1 确认调用系统信息
确认要调用的接口，以及对应数据项的 KEY。

确系统使用的编码格式为 UTF-
8 。

确认拿到的是接口资料为要使用的版本
2.2 环境搭建
本机电脑的调试环境
开发工具： Eclipse 或 Myeclipse 等；
编辑工具： EditPlus 、NotePad++、电脑自带的“记事本”等环境配置：使用JAVA开发需要 JAVA的环境配置。

使用其他语言开发需要配置相对该语言的环境。

服务器的调试环境硬件方面：由于网上支付平台提供的软件同商户的系统紧密集成，通常不需要额外的硬件投资。

软件方面： java 语言的 JDK1.5或以上，操作系统不限，服务器需要支持各开发语言对应的环境，
如果是 pom工程需要引入：
<dependency>
<groupId>com.caissa.erp</groupId>
<artifactId>dict</artifactId> <version>0.0.1</version>
</dependency> 备注：版本号可能会随着系统升级发生变化，以接入时的系统给出的为准。

3 数据字典接口调用流程
3.1 数据字典接口调用流程图
3.2 数据字典接口调用步骤
3.2.1 构造请求数据
系统开发人员根据要需求确认要请求的接口，以及接口的主要数据，主要包括：接口的方法，接口的参数值。

(1) 请求参数如下：
将请求参数拼装成请求对象后，
3.2.2 发送请求数据
接口交互方式为： dubbo。

服务注册中心 zookeeper 地址如下：生产环境地址：测试环境地址：
3.2.3 数据字典系统对请求数据进行处理
3.2.4 返回处理的结果数据
4 接口说明
为了方便接口的统一管理，以下接口都需要基于基础请求和基础应答基础请求参数
接口使用的 dubbo 接口
接口需要引入 dict0.0.1.jar
在 dubbo 配置文件加入
<dubbo:reference id= "dictItemsService"
interface="com.caissa.dict.api.service.DictItemsService" /> 4.1 获取类目下的字典项
接口编号： DICT-002
方法名称：getCatalogDownItem
4.1.1 请求参数
4.1.2 应答参数
4.1.3 使用举例
在使用类里需要注入进来，和使用 service 是一样调用@Resource (name = "dictItemsService" ) private DictItemsService dictItemsService ;
4.2 获取字典项下的字典项
接口编号： DICT-003
方法名称：getCatalogAndItemDownItem
4.2.1 请求参数
4.2.2 应答参数
4.2.3 使用举例
和上面的使用方式一样
5 常见问题及注意事项
5.1 调用方式
调用方式有两种 1 接口调用获取数据
6 附录
6.1 请求响应码
数据字典接口文档
6.2 数据字典系统KEY列表。