接口说明

1.1 接口 URL

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

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

1.2 数据交互规范

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

使用 POST 方式发送请求;支持 application/json

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

• 用 JSON 格式;
• 所有请求响应参数均进行加密签名，加密签名参考加解密加验签demo

1.3 调宜享花接口参数

1.3.1 公共请求参数

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

1.3.2 响应参数

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

1.4 宜享花调业务方接口参数

采用 application/json 方式

1.4.1 公共请求参数

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

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

1.4.2 响应参数

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

1.5 公共错误码

code	Msg	含义说明
0000	success	成功，
9000	业务异常	其他异常
9001	参数错误	参数错误（例如必传参数未传）
9002	appId 不存在	appId 不存在
9003	业务参数解密失败	业务参数解密失败
9004	参数签名验证失败	参数签名验证失败
9005	接口请求时间过期	接口请求时间过期
9006	业务参数格式错误	业务参数格式错误
9999	系统异常	系统异常（例如空指针异常）