欧飞Sup供货接口V2.2.doc

欧飞sup供货平台供货接口v2.2 欧飞sup供货系统供货接口规范 江苏欧飞电子商务有限公司2012年6月28日version：v2.22 欧飞sup供货平台供货接口v2.2 文档管理记录日 期修 改修 改 者版 本2012/04/20建立文档欧飞sup运营团队v2.02012/05/21返回充值结果时增加模板编号参数欧飞sup运营团队v2.12012/06/28新增返回频繁请求状态码7777欧飞sup运营团队v2.22012/06/28 v2.2更新说明： 接口参数中新增返回频繁请求状态码7777，默认访问时间为5秒每次，如供货商访问频繁则 会提示7777错误。2012/05/25 v2.1更新说明： 接口参数中增加模版编号值，支持自定义模版中配置的商品充值策略，自动触发充值模版中的失败退款等功能，提升处理效率，降低人工操作。15目录目录i一文档说明21.1文档目的21.2读者对象2二交互模式22.1 请求/响应交互模式22.2. 主动通知交互模式3三安全规范33.1 安全配置33.2 数据加密及数字签名43.3 访问控制43.4指令日志4四供货接口41.1接口说明41.2接口流程41.3订单获取接口64.4漏单检查接口（可选）84.5订单充值前确认接口104.6返回充值结果接口12五供货商管理13六附加信息说明141.1供货请求响应返回码信息14七开发支持14一文档说明1.1 文档目的欧飞sup供货商接入系统，为供货商提供了一套完善的供货接口，为供货商提供订单获取与充值结果返回服务。1. 欧飞sup供货商类型为供货形式及采购形式，目前只提供供货形式的供货商业务；2. 开放供货接口给供货商的同时，需要供货商在欧飞sup供货系统上开通帐户；3. 开发接口需要供货商在欧飞sup供货系统配置接口相关参数，提供实时接口供供货商查询使用；4. 供货接口包括：u 订单获取接口u 漏单检查接口（可选）u 订单充值前校验接口u 返回充值结果接口1.2 读者对象本文档阅读对象为欧飞sup供货商的开发技术。二交互模式2.1 请求/响应交互模式请求/响应模式是最常用的一种模式。在这种交互模式下，合作商系统向欧飞sup供货系统发送请求数据，并同步等待欧飞sup供货系统处理完毕之后返回的响应数据直至流程结束。服务请求是使用http协议发送给欧飞sup供货系统的，请求数据以post形式提交。2.2. 主动通知交互模式暂不开放。三安全规范3.1 安全配置安全配置包括以下内容：l 签名密钥配置（必选）a. 请求签名算法及密钥md5b. 返回签名算法及密钥md5l 加密密钥配置（可选）a. 请求加密算法及密钥md5b. 返回加密算法及密钥md5注：签名算法和密钥是必须的，加密算法和加密密钥为可选（只有一些特殊接口可能必须）。3.2 数据加密及数字签名在通讯过程中，采用rsa加密算法，欧飞sup供货系统产生公私密钥对，将公钥分配给供货商；供货商产生公私密钥对，将公钥分配给欧飞；交易过程中，对关键信息全文做数字摘要，再用私钥加密；关键信息域全文用公钥加密。接收报文方对密文解密，验签；而保证了数据的保密性、完整性和不可抵赖性。3.3 访问控制欧飞sup供货系统是根据请求参数中的供货商id来判断合作商的请求是否可以执行。供货商在访问供货接口之前，必须先开通供货接口的访问权限并在欧飞sup供货系统生成接口密钥。3.4指令日志欧飞sup供货系统会在国家相关法律法规要求的时限内保存合作商与欧飞之间所有完整交互指令，以方便日后为解决商业纠纷提供日志证据。合作商也应当按照国家相关法律法规的要求保存来自欧飞的响应数据与主动通知数据。四供货接口1.1 接口说明本接口主要目的是为了让供货商接入欧飞sup供货系统，能够在合作商系统中实现获取订单完成充值后将充值结果返回。 合作商系统作为请求客户端，按照本接口的约定发送请求，而欧飞sup供货系统监听来自合作商系统的请求给于处理，处理完成后将相关处理结果通知给合作商系统。1.2 接口流程接口流程图： 步骤说明：1) 合作商系统向欧飞系统发起订单获取请求，欧飞系统将待充值的订单返回给合作商系统；2) 合作商系统在收到待充值的订单后发送一次确认信息，查看是否存在漏单，欧飞系统核实之前发送的待充值订单记录，并将检查结果返回给合作商系统（该步骤可选）；3) 合作商系统在处理单笔订单前再次向欧飞系统发送充值前确认请求，核实该笔订单状态是否有变更，欧飞系统将确认结果返回给合作商系统；4) 合作商收到确认结果后开始处理订单，订单处理完成后将充值状态返回给欧飞系统，欧飞系统将响应的操作结果返回给合作商系统。如：合作商一次发起的请求，请求编号为：1234，欧飞返回的订单，其中订单编号为111，222，333，客户由于外挂离线或读取超时等原因，只收到了部分订单（111，222）或没有收到订单，这时合作商通过漏单检查接口，来验证该次请求合作商收到的订单和欧飞返回的订单是否一致（如，发送请求编号：reqid =1234，合作商收到的订单编号orderids =111,222，如果没收到订单就传orderids =），接口会返回合作商未收到的订单（订单编号333），在合作商充值之前，通过充值前确认接口，来确认订单是否可以充值（当合作商把订单拿走到充值这段时间内，订单可能会因为某些不可控因素撤单），避免损失，只有欧飞明确返回了该笔订单可以充值的时候，合作商才可以去充值，然后讲充值结果通过“返回充值结果接口”将充值结果返回给欧飞，以便及时同步订单状态。注：凡是不通过充值前确认接口来确认订单是否可以充值，导致的损失，欧飞不担负任何责任1.3 订单获取接口描述：获取需要充值的订单接口接口地址： http:/localhost:8077/supply.do必选参数：字段名变量名类型说明可空合作商代码partnerstring(32)合作商代码n模板编号tplidstring(32)模板编号n签名signstring(32)签名（md5加密后转为大写）（partner+tplid+apikey） 备注：apikey为加密密钥n请求编号reqidstring请求编号(请求编号唯一)n说明：合作商代码指供货平台对应的编号，如s000000，模板编号请先在平台创建一个自定义模板，系统自动会生成一个如mb000000000的模板编号。 可选参数：字段名变量名类型说明可空返回格式formatstring(20)xml，json，string，留空默认为xmly接口返回xml格式的节点元素：字段名节点名节点级别说明父节点必有根节点result1唯一的根节点y状态码status20000代表成功，其他见错误码resulty状态描述msg2如未成功操作，则为错误原因resulty数据data2所有动态数据的根节点resulty商品列表datalist3供货商发布的商品集合datan请求编号reqid4该次请求编号，用于漏单检查datalistn字段fields4返回字段列表，字段名之间用,分隔datalistn商品单项item4每一项商品datalistnitem节点之间返回的字段名和fields返回的字段一致，请根据fields返回的字段解析item节点中的数据示例：请求：http:/localhost:8077/supply.do?partner=*&tplid=20021&sign=74bc2374d6b78a3e0bb0cea4bd317ed8返回数据：0000数据获取成功fec8fe4415c7e57f0f3cbb4313f9d031河北移动充值100元1203261696648017391068*2012-03-26 16:52:2940100150278728022002120405100083id,userid,tplid,recharge_account,product_company,esale_account,esale_password,esale_paypsw,order_id,order_time,order_ip,esup_uid,product_id,product_name,order_num,product_par_value4.4漏单检查接口（可选）描述:验证一次请求获取的所有订单是否有漏单接口地址：http:/localhost:8077/checkorder.do必选参数：字段名变量名类型说明可空合作商代码partnerstring(32)合作商代码n模板编号tplidstring(32)模板编号n签名signstring(32)签名（partner+tplid+reqid+apikey） 备注：apikey为加密密钥n需要验证的订单编号orderidsstring(32)需要验证的订单编号,多个订单号之间用英文逗号隔开n请求编号reqidstring(32)请求编号n可选参数：字段名变量名类型说明可空返回格式formatstring(20)xml，json，string，留空默认为xmly接口返回xml格式的节点元素：字段名节点名节点级别说明父节点必有根节点result1唯一的根节点y状态码status20000代表成功，其他见错误码resulty状态描述msg2如未成功操作，则为错误原因resulty数据data2所有动态数据的根节点resulty商品列表datalist3供货商发布的商品集合datan请求编号reqid4该次请求编号，用于漏单检查datalistn是否有漏单leakdetecting4是否有漏单:false无漏单 true有漏单datalisty字段fields4返回字段列表，字段名之间用,分隔datalisty商品单项item4每一项商品，当leakdetecting为true时候，返回掉的订单数据，相关字段为fields返回的字段datalistyitem节点之间返回的字段名和fields返回的字段一致，请根据fields返回的字段解析item节点中的数据示例：请求：http:/localhost:8077/checkorder.do?partner=*&tplid=20021&sign=f269c4e7a4a3a702ed0f3e752101b60f&orderids=,12032616966480,12032616966777,&reqid=20405100083返回数据：0000订单验证结束fec8fe4415c7e57f0f3cbb4313f9d031河北移动充值100元1203261696664117390542*2012-03-26 16:53:3640100150752010852002120405100083trueid,userid,tplid,recharge_account,product_company,esale_account,esale_password,esale_paypsw,order_id,order_time,order_ip,esup_uid,product_id,product_name,order_num,product_par_value4.5订单充值前确认接口描述：订单充值前确认该笔订单是否可以充值接口地址:http:/localhost:8077/confirmrecharge.do必选参数：字段名变量名类型说明可空订单编号orderidstring(32)订单编号n小订单编号idstring(32)小订单编号n可选参数：字段名变量名类型说明可空返回格式formatstring(20)xml，json，string，留空默认为xmly接口返回xml格式的节点元素：字段名节点名节点级别说明父节点必有根节点result1唯一的根节点y状态码status20000代表成功，其他见错误码resulty状态描述msg2如未成功操作，则为错误原因resulty数据data2所有动态数据的根节点resulty是否可以充值canrechaege3是否可以充值:true可以充值false不可用充值datay示例：请求;http:/localhost:8077/confirmrecharge.do?id=17391068&orderid=12032616966480返回数据：0000数据获取成功true4.6返回充值结果接口描述：充值完成后将充值结果返回给欧飞接口地址：http:/localhost:8077/setorders.do必选参数：字段名变量名类型说明可空订单编号orderidstring(32)订单编号n小订单编号idstring(32)小订单编号n签名signstring(32)签名（partner+id+orderid+apikey）n订单状态orderstatestring(32)订单状态（4：充值成功 5：冲值失败 6：可疑订单）n合作商代码partnerstring(32)合作商代码n模板编号tplidstring(32)模板编号n可选参数：字段名变量名类型说明可空返回格式formatstring(20)xml，json，string，留空默认