接口说明

3.1 接口 URL

调用 API 的服务 URL 地址，目前提供了以下 2 个环境:

调用环境	服务URL
测试环境(双方人员联调使用)	线下沟通
正式环境	线下沟通

3.2 数据交互规范

• 使用 HTTPS 协议进行安全数据通信;

使用 POST 方式发送请求;支持 application/json;application/x-www-form-

• urlencoded

宜享花系统服务器端参数值和返回的数据均为 UTF-8 编码格式，返回数据使

• 用 JSON 格式;
• 所有请求响应参数均进行加密签名，加密签名参考加解密加验签demo
• 接口保持幂等性:重复请求请返回相同的结果(重点注意的接口在各个接口 文档有注明，其余接口也请保持该原则)

3.3 广告主调宜享花接口参数

3.3.1 公共请求参数

参数名称	类型	是否必传	说明	备注
appId	string	是	广告主Id	公共参数。广告主id，由宜享花统一提供。
method	string	是	方法名称	方法名称。决定具体调用的接口。
t	long	是	系统时间	公共参数。单位：毫秒(System.currentTimeMillis())，长度：13；该字段与服务方时间相差不能超过30分钟。
key	string	是	AES秘钥	RSA公钥加密后的AES秘钥，每次请求随机生成，具体参考加解密加验签demo
sign	string	是	RSA签名	RSA签名，对公共请求参数中除sign字段的所有参数签名的结果。具体参考加解密加验签demo
params	string	是	密文业务数据	密文业务数据，为AES加密后的业务参数。具体参考加解密加验签demo

3.3.2 响应参数

参数名称	类型	是否必传	说明	备注
code	int	是	响应返回码	参考3.5公共错误码
msg	string	是	响应信息	参考3.5公共错误码
data	string	否	密文业务数据	AES加密后的业务数据，具体参考加解密加验签demo
key	string	否	AES秘钥密文	RSA公钥加密后的AES秘钥，每次响应随机生成，具体参考加解密加验签demo
sign	string	是	RSA签名	RSA签名，对公共响应参数中除sign字段的所有参数签名的结果。具体参考加解密加验签demo

3.4 宜享花调广告主方接口参数

采用 application/json 方式

3.4.1 公共请求参数

金额相关都以（分）为单位

参数名称	类型	是否必传	说明	备注
appId	string	是	广告主ID	公共参数。广告主ID。
t	long	是	系统时间	公共参数。单位：毫秒(System.currentTimeMillis())，长度：13；该字段与服务方时间相差不能超过30分钟。
method	string	是	方法名称	方法名称。决定具体调用的接口。
key	string	是	AES秘钥	RSA公钥加密后的AES秘钥，每次请求随机生成，具体参考加解密加验签demo
sign	string	是	RAS签名	RAS签名，对公共请求参数中除sign字段的所有参数签名的结果。具体参考加解密加验签demo
params	string	是	密文业务数据	密文业务数据，为AES加密后的业务参数。具体参考加解密加验签demo

3.4.2 响应参数

参数名称	值类型	是否必传	说明	备注
code	int	是	操作返回码	参考3.5公共错误码
msg	string	是	操作信息	参考3.5公共错误码
data	string	否	密文业务数据	AES加密后的业务数据，具体参考加解密加验签demo
key	string	否	AES秘钥密文	RSA公钥加密后的AES秘钥，每次响应随机生成，具体参考加解密加验签demo
sign	string	是	RSA签名	RSA签名，对公共响应参数中除sign字段的所有参数签名的结果。具体参考加解密加验签demo

3.5 公共错误码

code=0，代表业务成功；code<0，代表公共异常；code>0，代表公共的业务异常。

code	Msg	含义说明
0	success	成功，只有为0才能进行业务结果的解析，后续接口文档不再说明code值
1	用户不存在	用户不存在
2	订单不存在	订单不存在（例如授信申请订单、借款申请订单）
-1	参数错误	参数错误（例如必传参数未传）
-2	appId 不存在	appId 不存在
-3	业务参数解密失败	业务参数解密失败
-4	参数签名验证失败	参数签名验证失败
-5	接口请求时间过期	接口请求时间过期
-6	业务参数格式错误	业务参数格式错误
-11	状态发生变更,请退回并重试	当前广告主状态发生变更需要用户退回得到最新状态
-99	系统异常	系统异常（例如空指针异常）

3.6 加解密加验签工具

宜享花会提供统一 java 加解密加验签工具包。基本流程如下图所示。

宜享花方加密加签流程

广告主方验签解密流程

广告主返回给宜享花的加密加签、以及广告主回调宜享花的加密加签类似。