示范对外接口参数文档

示范接口参数文档

模块一

1、说明

　　文档主要提供的是与系统对接时参数的相关说明。以下几点需要注意：

　　1、  系统间交互参数以JSON格式进行传输；

　　2、  加签验签：系统会给接入者提供秘钥，发送请求需要根据秘钥进行加签，通过后才能进行交易请求；同样，对于返回的结果系统也会进行加签，接收方需要用秘钥进行原交易加签并进行比较验证数据的完整性。

　　注：加签验签方法调用提供的jar包调用相应的方法即可。加签类为Sign。

    　　　交易请求时request.setHeaders(“code”);若在head标签中存放了当前机构code的MAP值，则支付系统的返回值sign标签会带有加签串。若不传则返回的sign为null.

　　　　 所有的接口含有异步应答的不论是否传输上诉字段返回的sign都需要进行验签。

　　3、  验签串传输：应用发起请求前需要将调用加签工具类返回的加签串存放在key为sign的Map中，并在发送http请求时增加request.setHeaders(Map)方法。

　　4、  返回格式报文：不同业务返回不一样，格式都是JSON，具体开发进行调试或者参考SDK开发包。

基本样例：

　　{"sign":"88888888888888888888","result":{"errorCode":"900017","errorMsg":"未找到原交易信息","tokUrl":null, "data":{"traceNo":"418548"}}}

　　所有交易的返回格式都如上面的报文，主体分为两部分，sign为验签串，result为结果集。其中result中的errorCode和errorMsg为参考应答码部分;backUrl为预留，暂不使用；

　　data是根据不同交易返回不同的值；

　　l  具体参考提供的开发SDK，里面提供了所有交易的模拟传输过程。

　　l  ☆☆☆ 注：在验证支付返回的加签串是否正确的时候，应用获取到result后调用加密方法传入的MAP值的KEY一定要为result，否则将会导致验签不过。☆☆☆

　　l  文档中所有交易的请求URL都为测试环境，测试通过后请更换生产环境链接地址。

2、接口一

　　请求URL 　　http://127.0.0.1:8080/test_store/UserServlet?method=userRegist

　　请求参数

　　应答参数

请求报文样例

 

　　　　　

 

 

应答报文样例