ISV产品接入指南2（DOC33）hph.docx

ISV产品接入指南目 录1文档目的32ISV接入提交项33接口开发与测试环境34ISV接入工作内容45接口定义55.1接口实现形式55.2平台提供给ISV的接口55.2.1Web Service（参数为实体对象）55.2.2Web Service（参数为XML字符串）55.2.3Post方式55.3ISV需要实现的接口定义65.3.1实现方式1：Web Service（参数为实体对象）65.3.2实现方式2：Web Service（参数为XML字符串）65.3.3实现方式3：Post方式65.4ISV接口实现注意事项65.5接口调用示例75.5.1示例：Web Service（参数为实体对象）75.5.2示例：Web Service（参数为XML字符串）85.5.3示例：Post方式85.6接口消息格式105.6.1请求消息105.6.2返回消息115.7消息体加密处理135.8消息调用返回码定义136接口开发与产品改造指南166.1接口实现过程步骤166.2配置文件166.3接口实现176.3.1产品订购176.3.2用户授权196.3.3健康检查266.3.4产品登录286.3.5心跳保持306.3.6数据同步316.3.7客户端登录317接口测试指南327.1测试准备工作327.1.1基本数据准备327.1.2基本数据检查327.2加解密算法测试337.3开通企业客户测试337.4企业用户授权测试337.4.1集成授权测试1337.4.2集成授权测试2347.5产品登录测试341 文档目的本文档用于于帮助IISV了了解其产产品接入入平台时时需要进进行哪些些工作、如如何进行行这些工工作、完完成后如如何进行行测试等等，ISSV在开开始接入入工作前前，请详详细阅读读此文档档内容。2 ISV接入入提交项项类型提交项重要程度描述文档产品图标必需用户订购时时显示的的产品图图标产品介绍必需产品简介，介介绍产品品的宣传传亮点、在在技术、功功能、应应用等方方面的特特点，以以及产品品能为用用户在哪哪些方面面带来价价值等用户手册必需详细介绍产产品的管管理功能能与应用用功能的的使用方方法，指指导企业业的管理理员与最最终用户户使用系系统安装手册必需系统的安装装部署说说明文档档，能让让平台维维护人员员参照此此文档即即可自行行完成产产品部署署FAQ可选提供最终用用户在使使用系统统中遇到到一些常常见的问问题时的的一般解解决方法法多媒体培训训材料可选Flashh、视频频或其它它形式的的多媒体体培训材材料程序系统程序必需产品可运行行程序与与数据库库等接口程序必需产品接口可可运行程程序产品接口访访问地址址必需产品接口部部署后的的访问地地址，其其中的主主机名与与端口可可替换为为实际部部署环境境的主机机名与端端口产品系统访访问地址址必需产品部署后后的访问问地址，其其中的主主机名与与端口可可替换为为实际部部署环境境的主机机名与端端口3 接口开发与与测试环环境资源描述http:/2222.92.1177.855:70012沙箱环境平平台登录录地址http:/2222.92.1177.855:70011/SSaaSS2ISSVInnterrfacce.aasmxx沙箱环境平平台Weeb SServvicee地址http:/2222.92.1177.855:70011/SSaaSS2ISSVInnterrfacceURRl.aaspxx沙箱环境接接收Poost数数据地址址http:/2222.92.1177.855:70012/SSSOLLogiin.aaspxx沙箱环境平平台单点点登录地地址http:/2222.92.1177.855:70009提供示例程程序、加加解密算算法、接接口调用用日志查查看、SSDK等等辅助调调试资源源4 ISV接入入工作内内容u ISV产品品改造1) 平台中维护护的数据据，ISSV产品品中不可可增加或或删除，如如企业、用用户。2) 平台中维护护的数据据，ISSV产品品中仅可可编辑平平台中不不包含的的数据属属性的值值。3) 去掉登录页页面4) 去掉注销、退退出等功功能5) 去掉修改密密码、修修改个人人信息等等功能6) 平台用户的的ID为为GUIID，IISV需需实现此此ID与与其产品品中的用用户身份份的对应应。7) 提供体验功功能，能能让用户户点击产产品体验验链接后后，以一一个默认认体验帐帐号的身身份直接接进入系系统，让让用户简简单试用用。u ISV接口口实现1) 企业客户业业务受理理接口：企业订订购时调调用，平平台会传传送企业业的信息息给ISSV；2) 企业客户员员工业务务受理接接口：企企业建立立用户时时调用，平平台会传传送用户户信息给给ISVV；3) 角色列表同同步（读读取）接接口：企企业给用用户分配配权限时时调用，如如果产品品无角色色功能，可可不实现现。4) 用户角色权权限同步步（读取取）接口口：企业业给用户户分配权权限时调调用，如如果产品品无角色色功能，可可不实现现。5) 用户角色权权限同步步（更新新）接口口：企业业给用户户分配权权限时调调用，如如果产品品无角色色功能，可可不实现现。5 接口定义5.1 接口实现形形式平台与ISSV之间间的交互互接口的的实现有有三种形形式，具具体如下下：1) 双方提供WWeb Serrvicce供对对方调用用，参数数与返回回值使用用实体对对象（实实体类），较较适用于于.Neet平台台或Jaava平平台。2) 双方提供WWeb Serrvicce供对对方调用用，参数数与返回回值使用用字符串串（XMML文本本），较较适用于于Javva平台台或其它它异构平平台。3) 双方提供接接收Poost数数据的页页面，PPostt的数据据及返回回值均为为字符串串（XMML文本本），较较适用于于Javva平台台或其它它异构平平台如PPHP、AASP等等。5.2 平台提供给给ISVV的接口口5.2.1 Web SServvicee（参数数为实体体对象）方法名称SaaSIISVIInteerfaaceXXMLSStriing参数数据类类型RequeestIInfoo返回值数据据类型RespoonseeInffo5.2.2 Web SServvicee（参数数为XMML字符符串）方法名称SaaSIISVIInteerfaaceXXMLSStriing参数数据类类型Strinng返回值数据据类型Strinng5.2.3 Post方方式请求方法POST参数形式Msg=xxml格格式的字字符串参数数据类类型Strinng返回值数据据类型Strinng5.3 ISV需要要实现的的接口定定义ISV从接接口实现现的三种种方式中中，选择择一种适适合自己己平台的的方式实实现给平平台调用用的接口口。5.3.1 实现方式11：Weeb SServvicee（参数数为实体体对象）方法名称ISVSaaaSIInteerfaace参数数据类类型RequeestIInfoo返回值数据据类型RespoonseeInffo5.3.2 实现方式22：Weeb SServvicee（参数数为XMML字符符串）方法名称ISVSaaaSIInteerfaaceXXMLSStriing参数数据类类型Strinng返回值数据据类型Strinng5.3.3 实现方式33：Poost方方式请求方法POST参数形式Msg=xxml格格式的字字符串参数数据类类型Strinng返回值数据据类型Strinng5.4 ISV接口口实现注注意事项项1) Web SServvicee方法只只有一个个参数，通通过传递递不同的的参数CCodee来指定定调用的的功能。2) namesspacce 必必须是：htttp:/SaaaSIInteerfaace.Sissparrk.MMm/，包包括最后后一个反反斜线。几种实现方方式提供供的接口口方法的的功能一一样，只只是参数数和返回回值类型型不同。具具体的业业务功能能和返回回信息由由请求消消息头的的操作码码（<CCodee>操作作码</Codde>）决决定，即即接口调调用只有有一个入入口。示示例如下下：publiic RessponnseIInfoo ISSVSaaaSIInteerfaace(ReqquesstInnfo reqq) ReespoonseeInffo rrespp = neww RessponnseIInfoo(); swwitcch (reqq.Heead.Codde) /企业业客户业业务受理理接口 ccasee "ISSV1001011": reesp = IISV1101001CoorpBBindd.ExxecuuteBBusiinesss(rreq); reeturrn rrespp; /企业业客户员员工业务务受理接接口 ccasee "ISSV1001022": reesp = IISV1101002SttafffBinnd.EExeccuteeBussineess(reqq); reeturrn rrespp; /角色色列表同同步（读读取）接接口 ccasee "ISSV1002011": reesp = IISV1102001PuullRRolees.EExeccuteeBussineess(reqq); reeturrn rrespp; /用户户角色权权限同步步（读取取）接口口 ccasee "ISSV1002022": reesp = IISV1102002PuullUUserrRolle.EExeccuteeBussineess(reqq); reeturrn rrespp; /用户户角色权权限同步步（更新新）接口口 ccasee "ISSV1002033": reesp = IISV1102003SyyncUUserrRolle.EExeccuteeBussineess(reqq); reeturrn rrespp; /未知知接口，非非法调用用 ddefaaultt: reeturrn nulll; 5.5 接口调用示示例5.5.1 示例：Weeb SServvicee（参数数为实体体对象） /构造RRequuesttInffo对象象并赋值值 ReequeestIInfoo reequeest = nnew ReqquesstInnfo(); ReequeestHHeaddInffo rreqHHeadd = neww ReequeestHHeaddInffo(); reeqHeead.SubbmittTimme = "22008807009099443337779" reeqHeead.ApppID = ""PROO2000805527000055" reeqHeead.Codde = "IISV1101001" reeqHeead.CTIID = "2200880700900000000555" reeqHeead.Priioriity = ""10"" reeqHeead.Verrsioon = "11" reequeest.Heaad = reeqHeead; sttrinng bbodyy = "<OOPTyype>>1</OPTTypee><OOPNoote>>变更原原因</OPNNotee>" /加密BBodyy并赋值值，“AABCDD12334”为为密钥 reequeest.Boddy = CrrptoograaphyyHellperr.CoomEnncryypt(boddy, "ABBCD112344"); /实例化化Webb Seerviice ISSV2SSaaSSIntterffacee serrvicce = neew ISVV2SaaaSIInteerfaace(); /调用WWeb Serrvicce ReespoonseeInffo rrespponsse = seerviice.ISVVSaaaSInnterrfacce(rrequuestt); /解密RRespponsseInnfo的的Boddy，还还原为XXML sttrinng bbodyyXmll = CrpptoggrapphyHHelpper.CommDeccryppt(rrespponsse.BBodyy, ""ABCCD12234"");5.5.2 示例：Weeb SServvicee（参数数为XMML字符符串） /构造BBodyy的XMML字符符串 sttrinng bbodyyXMLL = "<OOPTyype>>1</OPTTypee><OOPNoote>>开通<</OPPNotte>" /加密BBodyy的XMML字符符串，“AABCDD12334”为为密钥 sttrinng bbodyy = CrpptoggrapphyHHelpper.CommEnccryppt(bbodyyXMLL, ""ABCCD12234""); /构造请请求消息息XMLL字符串串 sttrinng rrequuesttXMLL = "<?xmll veersiion="11.0" eencoodinng="uttf-88" ?><<Msgg><HHeadd><CCodee>ISSV1001011</CCodee><CCTIDD>200080070990000000055<</CTTID>><ApppIDD>PRRO2000800610000001</ApppID>><SuubmiitTiime>>2000807709009444337779<</SuubmiitTiime>><Veersiion>>1</Verrsioon><<Priioriity>>10<</Prriorrityy></Heaad><<Boddy>"" + boddy + "<</Boody>></MMsg>>" /实例化化Webb Seerviice ISSV2SSaaSSIntterffacee serrvicce = neew ISVV2SaaaSIInteerfaace(); /调用WWeb Serrvicce sttrinng rrespponsseXMML = seerviice.ISVVSaaaSInnterrfacceXMMLSttrinng(rrequuesttXMLL); /取出BBodyy值 XmmlDoocummentt xmmlDooc = neew XmllDoccumeent(); xmmlDooc.LLoaddXmll(reespoonseeXMLL); XmmlNoode rooot = xmmlDooc.DDocuumenntEllemeent; sttrinng rrespponsseBoody = rroott.SeelecctSiinglleNoode("Boody"").IInneerTeext; /解密BBodyy，还原原为XMML sttrinng bbodyyXmll = CrpptoggrapphyHHelpper.CommDeccryppt(rrespponsseBoody, "AABCDD12334");5.5.3 示例：Poost方方式 / <suummaary>> / Poost方方式请求求Urll,返回回ressponnse字字符串 / </ssummmaryy> / <paaramm naame="poostDDataa">数数据流<</paaramm> / <paaramm naame="poostUUrl"">Urrl地址址</pparaam> / <reeturrns>>返回数数据</retturnns> priivatte staaticc strringg UrrlPoost(strringg poostDDataa,sttrinng pposttUrll) trry HHttppWebbReqquesst RRequuesttObjjectt = WebbReqquesst.CCreaate(posstUrrl) as HtttpWeebReequeest; / 设设定Coookiie RRequuesttObjjectt.CoookiieCoontaaineer = neew CoookieeConntaiinerr(); RRequuesttObjjectt.Crredeentiialss = CreedenntiaalCaachee.DeefauultCCreddenttialls; /ReequeestOObjeect.Prooxy = tthiss._wwebPProxxy; / 设设定请求求头。 RRequuesttObjjectt.PrrotoocollVerrsioon = neew Verrsioon(11, 00); RRequuesttObjjectt.KeeepAAlivve = trrue; RRequuesttObjjectt.PrreAuutheentiicatte = faalsee; RRequuesttObjjectt.Accceppt = "*/*"" /ReequeestOObjeect.Reffereer = poostUUrl; RRequuesttObjjectt.Heeadeers.Addd("AAcceept-Lannguaage"", "uutf-8"); RRequuesttObjjectt.UnnsaffeAuutheentiicattedCConnnecttionnShaarinng = trrue; /ReequeestOObjeect.UseerAggentt = "SMMPClliennt" RRequuesttObjjectt.Meethood = "PPOSTT" RRequuesttObjjectt.CoonteentTTypee = "apppliicattionn/x-wwww-foorm-urllenccodeed" RRequuesttObjjectt.AlllowwAuttoReedirrectt = truue; / PPostt数据 bbytee posstBuuffeer = Enncoddingg.UTTF8.GettByttes("Mssg="" + HtttpUttiliity.UrllEnccodee(poostDDataa); RRequuesttObjjectt.CoonteentLLenggth = pposttBuffferr.Leengtth; uusinng (Sysstemm.IOO.Sttreaam pposttStrreamm = ReqquesstObbjecct.GGetRRequuesttStrreamm() posstSttreaam.WWritte(pposttBuffferr, 00, pposttBuffferr.Leengtth); posstSttreaam.CClosse(); /网络络响应对对象 HHttppWebbRessponnse ressp = ReequeestOObjeect.GettRessponnse() aas HtttpWeebReespoonsee; SSysttem.IO.Strreamm reespSStreeam = rrespp.GeetReespoonseeStrreamm(); /获取取返回数数据保护护包 SSysttem.IO.StrreammReaaderr sttreaamReead = nnew Sysstemm.IOO.SttreaamReeadeer(rresppStrreamm, EEncoodinng.DDefaaultt); SStriingBBuillderr sttrReet = neew StrringgBuiildeer(); sstrRRet.Apppendd(sttreaamReead.ReaadTooEndd(); rresppStrreamm.Cllosee(); rrespp.Cllosee(); rretuurn strrRett.TooStrringg(); caatchh (Exxcepptioon eex) tthroow neww Exccepttionn("URRL方式式调用错错误."" + ex.Messsagge, ex); /reeturrn eex.MMesssagee; 接收方示例例： prootecctedd voiid PPagee_Looad(objjectt seendeer, EveentAArgss e) sttrinng mmsg = RRequuestt"MMsg""/对请求求消息mmsg进进行解析析并做业业务处理理，生成成返回消消息。 Reespoonsee.Cllearr(); Reespoonsee.Wrritee("<<ResspMeessaage>><Heead>><Coode>>SYSS103301<</Coode>><CTTID>>200080331500000000223</CTIID>"" + "<<ApppID>>PROO2000805527000055</AAppIID><<SubbmittTimme>220088040091661900775500<</SuubmiitTiime>>" + "<<Verrsioon>11.0<</Veersiion>><Prriorrityy>100</PPriooritty><</Heead>>" + "<<Boddy><<CorrpIDD>300</CCorppID>></BBodyy></ResspMeessaage>>"); 5.6 接口消息格格式5.6.1 请求消息请求消息是是指调用用接口的的一方发发出的消消息，即即Webb Seerviice方方法的传传入参数数。<?xmll verrsioon="1.00" enccodiing="utff-8"" ?>><Msg>> <!- 消消息头 ->> <Heead>> <<Codde>ISVV101101<</Coode>> <<CTIID>200080770900000000555</CTIID> <<ApppID>>PROO2000805527000055</ApppIDD> <<SubbmittTimme>2000807709009444337779<</SuubmiitTiime>> <<Verrsioon>1</Veersiion>> <<Priioriity>>10</Priioriity>> </HHeadd> <!- 消消息体(经过加加密的字字符串，原原文为XXML片片段) ->> <Boody>>id99#F999044sfLLO(%)$DSSKLDDOFEEKRXXBFSSDF#$LLCL_+$LXVV:"SSFLOOW(#$DDVS<</Boody>></Msgg>5.6.1.1 消息头所有接口的的请求消消息的消消息头格格式相同同，具体体属性说说明见下下表：名称说明数据类型长度（字节节）Code操作码Strinng8CTID客户端交易易序列号号（在发起起方唯一一标识一一个交易易的流水水号，客客户系统统内166位唯一一标示号号）组成方式：8位日日期88位唯一一数，每每天从00000000001开始始，如220088031550000000001Strinng16AppIDD业务应用标标识（标标识是哪哪个ISSV应用用系统，由平台统一分配）Strinng8SubmiitTiime提交时间，格式为为：YYYYMMMDDDHHmmmsssffffStrinng17Versiion版本号（保保留字段段）当前值: 1Strinng10Priorrityy优先级（保保留字段段）当前值: 10Int35.6.1.2 消息体每一个接口口的请求求消息的的消息体体的格式式各不相相同，具具体请参参见各接接口的详详细消息息格式说说明。5.6.2 返回消息请求消息是是指接口口被调用用的一方方返回的的消息，即即Webb Seerviice方方法的返返回值。<?xmll verrsioon="1.00" enccodiing="utff-8"" ?>><Msg>> <!- 消消息头 ->> <Heead>> <<Codde>ISVV101101<</Coode>> <<CTIID>200080770900000000555</CTIID> <<STIID>200080770900000019887</STIID> <<ApppID>>PROO2000805527000055</ApppIDD> <<ReqquesstTiime>>2000807709009444337779<</ReequeestTTimee> <<RessponnseTTimee></RessponnseTTimee> <<Verrsioon>1</Veersiion>> <<Priioriity>>10</Priioriity>> <<Staatuss>0</Sttatuus> </HHeadd> <!- 消消息体(经过加加密的字字符串，原原文为XXML片片段) ->> <Boody>>id99#F999044sfLLO(%)$DSSKLDDOFEEKRXXBFSSDF#$LLCL_+$LXVV:"SSFLOOW(#$DDVS<</Boody>></Msgg>5.6.2.1 消息头所有接口的的返回消消息的消消息头格格式相同同，具体体属性说说明见下下表：名称说明数据类型长度（字节节）Code操作码Strinng8CTID客户端交易易序列号号（在发起起方唯一一标识一一个交易易的流水水号，客客户系统统内166位唯一一标示号号）组成方式：8位日日期88位唯一一数，每每天从00000000001开始始，如220088031550000000001Strinng16STID服务端交易易序列号号（在接受受方唯一一标识一一个交易易的流水水号，平平台系统统内唯一一20位位唯一流流水）组成方式：ApppID + “_” + 8位日日期88位唯一一数，每每天从00000000001开始始，如11001120008031550000000001Strinng25AppIDD业务应用标标识（标标识是哪哪个ISSV应用用系统，由平台统一分配）Strinng16RequeestTTimee请求接受时时间，格式为为：YYYYMMMDDDHHmmmsssffffStrinng17RespoonseeTimme响应处理时时间，格式为为：YYYYMMMDDDHHmmmsssffffStrinng17Versiion版本号（保保留字段段）当前值：11