智能调度平台接口(地图服务系统分册)

营销GIS系统与用电信息采集系统接口方案智能调度配送管理平台接口规范

（地图服务系统分册）二〇一四年十一月智能调度平台接口规范（地图服务系统分册）目录1. 概述 31.1. 编写目的 31.2. 预期读者 31.3. 术语 31.4. 交互示意图 32. 接口需求 32.1. 场站标注信息接口 32.1.1. 需求描述 32.1.2. 数据类清单 32.1.3. 接口交互流程图 42.1.4. 流程图说明 42.1.5. WebService服务清单 42.2. 气源地标注信息接口 52.2.1. 需求描述 52.2.2. 数据类清单 52.2.3. 接口交互流程图 52.2.4. 流程图说明 62.2.5. WebService服务清单 63. Webservice集成 63.1. 场站标注信息接口 63.1.1. 场站标注信息接口服务 63.2. 气源地标注信息接口 73.2.1. 气源地标注信息接口服务 74. WebService接口规约 84.1. 技术架构 84.1.1. 技术架构概述 84.1.2. 认证机制 84.2. 数据规约 104.2.1. Webservice接口数据协议 104.2.2. XML数据格式约定 114.2.3. XML数据格式示例 114.3. WebServiceWSDL 124.3.1. 地图服务系统WSDL 125. 示例 135.1. 示例:嵌套情况 135.2. 示例:返回0行 13

修订历史版本类型成稿日期责任人备注

概述编写目的为统一智能调度管理配送平台与地图服务系统的集成接口，特制定本接口规范，以指导智能调度管理配送平台集成的设计、开发、测试及部署实施工作。预期读者本接口规范预期读者为智能调度管理配送平台和地图服务系统接口设计开发人员。术语Webservice集成：通过WebService的方式进行数据传递的接口集成方式。交互示意图接口需求场站标注信息接口需求描述根据智能调度平台业务开展的要求，需要从GIS系统中获取场站位置数据，为销售管理、气源采购管理、运力采购管理、智能匹配管理、运输执行等业务开展提供数据支撑。数据类清单智能调度配送管理平台：数据类型数据类交互频度场站位置信息场站位置明细信息实时接口交互流程图流程图说明1、智能调度管理平台在业务过程中，标注场站地图信息并存储场站地图信息。2、智能调度管理平台调用地图服务系统Webservice接口，通知地图服务系统将，并产生的场站位置信息发送到地图服务系统。3、地图服务系统接收到智能调度平台发送过来的场站位置信息和Webservice通知后，存储相关信息。4、地图服务系统将结果反馈给智能调度平台。WebService服务清单服务提供者服务分类服务名称地图服务系统??气源地标注信息接口需求描述根据智能调度平台业务开展的要求，需要从GIS系统中获取气源地位置数据，为销售管理、气源采购管理、运力采购管理、智能匹配管理、运输执行等业务开展提供数据支撑。数据类清单智能调度配送管理平台：数据类型数据类交互频度气源地位置信息气源地位置明细信息实时接口交互流程图流程图说明1、智能调度管理平台在业务过程中，标注气源地地图信息并存储气源地地图信息。2、智能调度管理平台调用地图服务系统Webservice接口，通知地图服务系统，并将产生的气源地位置信息发送到地图服务系统。3、地图服务系统接收到智能调度平台发送过来的气源地位置信息和Webservice通知后，存储相关信息。4、地图服务系统将结果反馈给智能调度平台。WebService服务清单服务提供者服务分类服务名称地图服务系统??Webservice集成场站标注信息接口场站标注信息接口服务接口说明接口说明根据智能调度平台业务开展的要求，需要从GIS系统中获取场站位置数据，为销售管理、气源采购管理、运力采购管理、智能匹配管理、运输执行等业务开展提供数据支撑。接口方式Webservice方法名称?服务端地图服务系统调用端智能调度管理配送平台数据频度实时输入参数中文名输入参数英文名参数格式非空含义?????返回值中文名称返回值英文名称返回值格式非空含义成功/失败标志RLT_FLAGSTRING(8)1成功0失败失败原因FAIL_MEMOSTRING(256)数据交互说明气源地标注信息接口气源地标注信息接口服务接口说明接口说明根据智能调度平台业务开展的要求，需要从GIS系统中获取气源地位置数据，为销售管理、气源采购管理、运力采购管理、智能匹配管理、运输执行等业务开展提供数据支撑。接口方式Webservice方法名称?服务端地图服务系统调用端智能调度管理配送平台数据频度实时输入参数中文名输入参数英文名参数格式非空含义?????返回值中文名称返回值英文名称返回值格式非空含义成功/失败标志RLT_FLAGSTRING(8)1成功0失败失败原因FAIL_MEMOSTRING(256)数据交互说明WebService接口规约技术架构技术架构概述智能调度平台WebService接口采用Xfire技术实现。客户端和服务器用SOAP协议通过HTTP来交互，客户端根据WSDL描述文档生成SOAP请求消息发送到服务端，服务端解析收到的SOAP请求，调用Webservice，然后再生成相应的SOAP应答送回到客户端。认证机制智能调度平台的所有WebService服务均需要认证通过（部分需要授权）才能够被调用。智能调度平台WebService服务接收到请求后首先从消息上下文中获取用户名和密码，进行认证，认证通过后再调用具体服务。作为客户端，应用程序代码(使用Xfire的客户端编程模型来编写的)需要将用户名和密码设置到MessageContext中进行调用。根据客户端程序语言及调用方式不同，设置的方法也不同，下面列举出客户端程序语言为java的两种设置方式：客户端调用平台使用xfire技术发布webservice服务，建议客户端也使用XFire来访问外部服务，以下客户端调用示例代码都是基于xfire技术来编写的。一、调用方式客户端可以通过如下两种方式调用外部服务：根据WSDL创建客户端调用如果服务端没有提供接口，可以使用这种简单的方式来调用，如下为客户端调用示例代码：publicstaticvoidmain(String[]args){ Stringwsdl="4:6001/athena_server/pf_webservice/com.ls.pf.base.impl.auth.extramodel/userService/service?wsdl"; Clientclient=newClient(newURL(wsdl));//invoke第一个参数为服务方法名，第二个参数为服务参数 Object[]results=client.invoke("isAdmin",newString[]{"SYSADMIN"}); System.out.println(results[0].toString()); results=client.invoke("getUserBySysUserName",newString[]{"SYSADMIN"}); System.out.println(results[0].toString());}通过服务端提供的接口调用如果服务端有提供接口，或者服务参数和返回值为复杂类型时，则建议使用这种方式，客户端调用代码如下：publicstaticvoidmain(String[]args){ Stringwsdl=":7080/amber_server/pf_webservice/com.ls.pf.base.impl.auth.extramodel/userService/service"; ServicesrvcModel=newObjectServiceFactory().create(IUserService.class); XFireProxyFactoryfactory=newXFireProxyFactory(XFireFactory .newInstance().getXFire()); try{ IUserServiceuserService=(IUserService)factory.create(srvcModel,wsdl); XFireProxyproxy=(XFireProxy)Proxy.getInvocationHandler(userService);Clientclient=proxy.getClient(); Booleanresut= userService.isAdmin("SYSADMIN"); }catch(MalformedURLExceptione){ e.printStackTrace(); }}二、添加验证信息头当访问的webservice服务需要进行认证时，客户端调用代码需要传入认证信息头，如下分别为服务端是AuthenticationHandler认证和ws-security认证时验证头添加方式服务端为AuthenticationHandler认证当服务端配置了AuthenticationHandler认证时，客户端通过如下示例代码添加验证头：Clientclient;ClientAuthenticationHandlerhandler= newClientAuthenticationHandler("用户名","密码");client.addOutHandler(handler);client.addInHandler(handler)服务端为ws-security认证当服务端配置成ws-security认证时，客户端通过如下示例代码添加验证头。注：认证用户名在pf_user表中的密码必须为n9zf4TIQEzubAi0PrSL8qHuEgMaXMazk6uh53w5Iclient.addOutHandler(newDOMOutHandler());Propertiesproperties=newProperties();configureOutProperties(properties);client.addOutHandler(newWSS4JOutHandler(properties));privatestaticvoidconfigureOutProperties(Propertiesproperties){ //Actiontoperform:usertokenproperties.setProperty(WSHandlerConstants.ACTION,WSHandlerConstants.USERNAME_TOKEN);//Setpasswordtypetohashedproperties.setProperty(WSHandlerConstants.PASSWORD_TYPE,WSConstants.PW_DIGEST);//Usernameinkeystoreproperties.setProperty(WSHandlerConstants.USER,"SYSADMIN");//Useddoretrivepasswordforgivenusernameproperties.setProperty(WSHandlerConstants.PW_CALLBACK_CLASS,PasswordHandler.class.getName()); }其他的调用方式及其他语言设置方式请查阅Xfire相关文档。数据规约Webservice接口数据协议采用WebServiceSOAP协议。客户端和服务端采用XML格式的字符串来交互业务数据，客户端将业务数据组织成XML格式的字符串作为入参调用服务端接口，服务端解析XML格式的字符串得到业务数据处理业务并把结果组织成XML格式的字符串返回给客户端。XML数据格式约定业务数据组织成XML格式的字符串来交互，该XML格式的字符串遵循以下规则：XML编码格式为“UTF-8”以<DBSET></DBSET>来标记数据集的开始和结束；以<R></R>标记一行记录；以<CN=“字段名”>字段值</C>标记字段名称及值；以<DBSETRESULT=”此处为返回标识值”></DBSET>标记返回标识；字段为日期的遵循以下约定：年月日格式统一为“YYYY-MM-DD”，如“2006-06-22年月格式为“YYYYMM”，如“200606”。XML数据格式示例示例：只有数据集<?xmlversion="1.0"encoding="UTF-8"?><DBSET><R><CN="dw">0100</C><CN="dwmc">省电力公司</C></R></DBSET>示例：只有返回标识<?xmlversion="1.0"encoding="UTF-8"?><DBSETRESULT="0"/>示例：既有返回标识，又有数据集<?xmlversion="1.0"encoding="UTF-8"?><DBSETRESULT="2"><R><CN="dw">0100</COL><CN="dwmc">省电力公司</COL></R><R><CN="dw">0200</COL><CN="dwmc">地市电力公司</COL></R></D