1、湖南省地方标准DB43湖南省质量技术监督局 发 布物流园区信息及交换规范Part2:the specification for information interconnection and exchange第2部分:信息互联与交换规范The specification for logistics park information and exchangeICS 90.010.01P 04DB43/T 1163.22016 2016-05-22实施2016-03-22 发布DB43/T 1163.22016 I 目 次 前言1 范围 12 规范性引用文件 13 缩略语 14 信息互联与交换规范
2、原则 14.1 实用性 14.2 可靠性 14.3 简明性 15 统一身份认证 25.1 概述 25.2 身份认证 25.3 统一身份认证服务 26 数据交换接口规范 26.1 数据交换接口类型 26.2 数据交换技术规范 36.3 数据交换格式规范 36.4 数据类型规范 36.5 接口服务规范 3附录 A(资料性附录) 数据交换接口规范附件 5DB43/T 1163.22016 II 前 言 本部分根据GB/T 1.12009给出的规则起草。 DB43/T 11632016 物流园区信息及交换规范分三个部分: 第1部分:基础数据规范 第2部分:信息互联与交换规范 第3部分:应用服务数据规范
3、 本部分为DB43/T 1163.22016第2部分:信息互联与交换规范 本部分由湖南省联合运输办公室提出并归口。 本部分起草单位:湖南省联合运输办公室,湖南交通物流信息服务有限公司,衡阳市雁城物流园有限公司。 本部分主要起草人:欧阳建喜、卢勤学、方志宏、刘敏、张艺、王飞、李彬旗、陈金龙。 DB43/T 1163.22016 1 物流园区信息及交换规范 第2部分:信息互联与交换规范 1 范围 本部分规定了物流园区信息互联与交换的统一身份认证和数据交换接口要求。数据交换接口规范包含数据交换接口类型、数据交换技术、数据格式、数据类型及接口服务规范。 本部分适用于物流相关的信息平台、电子数据交换与信
4、息管理系统等的设计与开发应用。 2 规范性引用文件 下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件,仅注日期的版本适用于本文件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。 DB43/T 1163.12016 物流园区信息及交换规范 第1部分 基础数据规范。 3 缩略语 HTTP:超文本传输协议(Hypertext Transfer Protocol)。 WSDL:Web服务的描述语言(Web Services Description Language)。 SOAP:简单对象访问协议(Simple Object Access Protocol) WS-Sec
5、urity:Web服务安全(Web Service Security)。 API:应用程序编程接口(Application Programming Interface)。 XML:可扩展标记语言(Extensible Markup Language)。 JSON:JavaScript对象表示法(JavaScript Object Notation)。 4 信息互联与交换规范原则 4.1 实用性 立足物流业务实际情况,针对物流信息平台接口服务需求,制定物流业务信息交换的主要应用服务接口,注重实用性。 4.2 可靠性 在接口设计中,充分注意接口的安全性和可靠性,采用多种安全防范技术和措施,保障交换
6、信息安全,保障接口长期稳定可靠运行。 4.3 简明性 设计中利用先进和成熟的Web Service技术,辅以接口示例代码,来提高接口规范的通用性和易用性。 DB43/T 1163.22016 25 统一身份认证 5.1 概述 统一身份认证是物流信息系统之间进行数据交换的身份验证规范,通过统一的安全认证与授权机制确保信息共享与资源交换双方身份的唯一性和合法性。 5.2 身份认证 用户首先通过统一身份认证服务进行账号注册,获得系统账号。用户通过系统账号进行登录,统一身份认证服务根据账号信息的合法性返回认证令牌。在进行数据交换时,用户提供认证令牌进行身份有效性验证,验证通过后允许进行数据交换。 5.
7、3 统一身份认证服务 统一身份认证服务是一种web服务,从请求消息和响应消息两部分对服务属性进行约定, 实现对用户身份的安全认证。 5.3.1 用户认证及授权请求 用户发起身份认证及授权请求,统一身份认证服务接收用户请求,对用户信息进行认证及授权。用户认证及授权请求过程中需要用户身份信息,请求参数中包括用户名、手机号码和密码,用户认证及授权输入参数见表1。 表1 用户认证及授权输入参数 类型 字段 含义 是否必须 String UserName 用户名称 是 String Password 密码 是 String MobileTelephoneNumber 手机号码(UserName和Mobi
8、leTelephoneNumber至少一个不能为空) 否 5.3.2 用户认证及授权响应 用户向身份认证系统提交授权请求,身份认证系统进行验证后将用户的令牌标识返回给用户。如果认证失败,返回用户错误代码和错误原因;反之,认证成功,身份认证系统返回成功授权用户令牌,用户认证及授权响应结果见表2。 表2 用户认证及授权响应结果 类型 字段 含义 说明 String TokenID 用户令牌标识 6 数据交换接口规范 6.1 数据交换接口类型 6.1.1 与政府间的数据接口 提供与物流相关政府部门(如交通运输管理部门、口岸管理部门、工商税务管理部门、公安部门等)DB43/T 1163.22016 3
9、 电子政务系统中与物流相关的数据接口,实现物流相关行政数据的信息查询。 6.1.2 与企业间的数据接口 提供企业间物流业务数据交换的接口,实现企业间物流数据信息交换和信息共享。 6.1.3 与其他公共服务信息平台间的数据接口 提供与其他公共服务信息平台的数据交换接口,实现园区信息系统与外部平台的物流数据信息交换和信息共享。 6.2 数据交换技术规范 数据交换接口主要采用Web Service技术,遵循HTTP、WSDL、SOAP、WS-Security等多种协议的技术规范,提供信息互联与交换应用API。 6.3 数据交换格式规范 数据交换支持传统的XML数据格式的同时,还支持轻量级的JSON数
10、据格式。用于满足各类应用系统间数据交换的统一性与规范化,实现各个应用系统间快捷灵活的信息共享与数据交换。 6.4 数据类型规范 数据类型分为简单数据类型和复杂数据类型,具体如下: 1) 简单数据类型: String:字符串类型,表示任何的合法字符串; Boolean:布尔型,表示二进制逻辑,True或False; Base64Binary:表示任意Base64编码的二进制数; Date:表示YYYYMMDD格式的日期; Time:表示hhmmss格式的时间; DateTime:表示格式为YYYYMMDDhhmmss的时间; Int:整数型。 2) 复杂数据类型: 对象:对象在JSON中表示为“
11、”中的内容,数据结构为key:value, key:value,.的键值对的结构,key为对象的属性,value为对应的属性值。属性值的类型可以是数字、字符串、数组和对象; 数组:数组在JSON中表示为“”中的内容,数据格式为 “value “,“ value “,.的字段值结构。value为数组的字段值。字段值的类型可以是数字、字符串、数组和对象。 6.5 接口服务规范 接口服务从请求参数和返回结果两部分对接口属性进行约定,请求参数分为系统参数和业务参数两种类型,接口返回结果规范约定了接口服务响应的数据格式。接口请求和响应的JSON格式示例文件参考附录A(资料性附录)接口服务规范附件的A.1
12、、A.2。 6.5.1 系统参数规范 系统参数是接口服务定义的一组参数,每个服务都拥有这些参数,用于进行身份认证、数据格式等接口服务特性的定义。系统参数见表3。 DB43/T 1163.22016 4表3 系统参数表 参数名称 是否必须 参数说明 AppKey 是 应用键值,用于标识应用的惟一值。 TokenID 否 认证令牌,一般是一个32位的 UUID,在登录认证后获得; Format 否 数据格式,可选值为 XML 和 JSON,默认为JSON。 6.5.2 业务参数规范 业务参数由具体的接口服务定义,每个接口服务都可以定义若干个业务参数。调用接口服务时,业务参数可以根据业务需要自由组合
13、进行传递。 6.5.3 接口返回结果规范 接口返回结果由Code,Msg,Body三部分组成,Code部分表示返回的结果编码,Msg部分表示提示信息内容,Body部分为返回的业务结果。接口返回结果规范见表4。 表4 接口返回结果规范表 序号 属性名 说明 1 Code 结果编码 2 Msg 提示信息内容 3 Body 业务结果 6.5.4 正常返回结果 接口调用如果正常,则系统直接返回编码值Code 为200,结果信息Msg为操作成功,同时会将业务数据返回到Body部分。 6.5.5 异常返回结果 接口调用如果异常,系统会根据错误的类型返回特定的编码值Code、错误说明Msg,异常返回结果编码
14、与错误说明对应关系参照附录A(资料性附录)接口服务规范附件的A.3。异常情况下,Body部分的结果可以为空或是对错误信息的详细描述。 DB43/T 1163.22016 5 附录A (资料性附录) 数据交换接口规范附件 A.1 接口请求格式示例 “UserName“: “zhangsan“, “RealName“: “张三“, “Birthday“: “1975-06-23“, “Age“: “40“, “TelephoneNumber“: “0731-80861236“, “Address“: “湖南省长沙市岳麓区“, “Email“: ““, “EnterpriseName“: “某某物流
15、园区“, “Remark“: “示例数据“ A.2 返回结果格式示例 “code“: “200“, “msg“: “操作成功“, “body“: “UserName“: “zhangsan“, “RealName“: “张三“, “Birthday“: “1975-06-23“, “Age“: “40“, “TelephoneNumber“: “0731-80861236“, “Address“: “湖南省长沙市岳麓区“, “Email“: ““, “EnterpriseName“: “某某物流园区“, “Remark“: “示例数据“ A.3 异常返回结果编码及提示信息对照表 异常返回结果编码及提示信息对照情况详见表A.1。 DB43/T 1163.22016 6表A.1 异常返回结果编码及提示信息对照表 Code Msg Code Msg 1 服务不可用 7 权限不足 2 服务不存在 8 请求超时 3 服务被禁用 9 缺少参数 4 服务已作废 10 无效的参数 5 编码错误 11 非法的参数 6 数据解析错误 12 业务逻辑出错