登录
退出
当前位置:

绵阳共享交换平台接口文档

发布人: 政管局管理员 时间:2020-12-15 16:47:56

1. 概述

1.1. 编制说明

本文档的编写目的是为了统一定义绵阳共享交换平台接口调用实现的技术方式,详细描述接口的交互信息和协议等,保证接口的一致性、稳定性以及可持续性。

1.2. 接口协议说明

接口通讯采用HTTP的RestFul协议方式提供,请求参数使用form表单格式,响应的参数采用JSON格式,编码均为UTF-8格式。

1.3. 网络环境要求

生产环境和测试环境对接依托于电子政务外网环境并且需要向政管局申请添加白名单

2. 术语和定义

下列术语和定义仅适用于本文档。

2.1. 流水号--request_id

请求流水号随机生成的uuid

2.2. 时间戳timestamp

时间戳是指格林威治时间1970年01月01日00时00分00秒(北京时间1970年01月01日08时00分00秒)起至现在的总秒数。

2.3. 系统接入码--access_key

绵阳共享开放平台统一分配接入系统编码,详见绵阳共享开放平台后台

2.4.  口版本--version

资源提供方发布接口时所填写版本号,详见绵阳共享开放平台对应接口展示资料

2.5. sign签名

使用RSA加密,请求参数防篡改签名(详见附录A A.1 请求参数签名示例)

2.6. 提供方接口请求参数--biz_content

根据提供方接口所需请求参数传入,并且部分参数需要使用AES对称加密(详见附录A A.2 AES加密、解密算法示例)。

2.7. 提供方接口请求格式--format

规定传入的提供方接口请求参数格式,通常为“json”。

 

 

3. 流程图

 

4. 接口详细

4.1. 公用HTTP调用接口

4.1.1. 接口描述

服务提供方挂接接口后,绵阳共享交换平台会生成统一的调用地址,并以服务标识后缀区分。接口需要由第三方业务系统按照绵阳共享交换平台要求规范进行挂接

4.1.2. 接口服务提供方

服务端:第三方业务系统

客户端:绵阳共享交换平台

4.1.3. 接口地址

http://ip/yhbcp-engine/rest/  +  服务标识

4.1.4. 接口协议说明

接口实际请求实例如下:

接口方式

HTTP

请求类型

POST

传参方式:form表单

access_key=MYXT121494

&biz_content=对应原接口业务参数

&format=JSON

&request_id=d5b489289d6245208553

×tamp=1

&sign=通过私钥生成的签名串

&version=接口版本号(非必填,如果接口提供方未填写,则不用传)

4.1.5. 接口请求参数说明

参数代码

参数名称

参数类型

参数长度

是否必填

注释说明

access_key

系统接入码

字符串

16

调用方系统接入码,由共享开放平台注册分配

biz_content

接口提供方请求参数

字符串


接口提供方业务入参,并且部分参数值通过AES对称加密

version

接口版本号

字符串

16


format

业务入参格式

字符串

16

biz_content参数格式,固定为JSON

request_id

流水号

字符串

32

随机uuid

timestamp

时间戳

字符串


时间戳是指格林威治时间1970年01月01日00时00分00秒(北京时间1970年01月01日08时00分00秒)起至现在的总秒数。

sign

签名

字符串


通过私钥生成的签名串

 

4.1.6. 接口实际请求示例

实际使用时加密以实际密钥参数为准。

请求格式(提供方参数传递JSON)

access_key=MYXT121494&biz_content={"encryptParam":"Hhvuoy/6fnJv3uStvlN5ATzQwCpADEjsNurF2qTadmVGV8OjEOOZ1OzoiFdF2n8JgjGIg5hnaSoiv3q/iKd8yU46AaQxP/Iiy9nZi%2B

nGiH2DtpxUfZdRxgBfLc4wqZtFdzhC2KhEjdVWqHXKx5ks1dfLAf/D2SAu4AQHhCH60nTYfdc18Y6GxAnA7JhctiP1ybaSFV8bovJaXJF8o04mo7TOjFsfzyZt4XesikuKGE30EA40xqd9aflNLWYi9aUIFroK7Yh3vuVXHDB1En8835YLcmdH/5zqv0uNL3Qf08tBv5BTLe/Lfiuj1Dvrcj4lZtFbQKhkm/isQs1q8Lmzgw==","rsaUserId":"06ac5e097e31464fa3a0cfdb83fb43a1","timestamp":"637220223723217221"}&format=JSON&request_id=d5b489289d6245208553×tamp=1&sign=CarlR5IfSmk2vT0PuOrqd6u34uXHbrq00Rhuc%2B8aA3Ql9gXFGMv5aw1rZGAvxmtI58c/oho8%2BJTBrgTA0Jh4Ht1XbxNAOv2RjsgV6Zsu7EfgZjrlz/cvOXKL%2Bf0kryeYB55Z6u0mYS4xEzw2Vaf0AMhhvEyZV/Yec8Y/FVl%2BuxeD4ENfXpcxuyDw3D9AcDz0ngUekwS3vA8PGJF8kNSuJEsSOHm%2BLKbh9IqYlXIZk3IfBdrmLj3ibwjqnMMOWW1GE/PDKjUbbO%2Bk8ZqQPtDa0EoBgQQm6l%2BIZtxJ3mwatWj6nfHr2nm%2BwbnKV0%2Bt314rw4vCsrNpkNxr/8BVjeiDGg==

 

4.1.7. 接口返回参数说明

Ø 公共模板返回参数说明

参数代码

参数名称

参数类型

参数长度

是否必填

注释说明

Code

请求结果状态码

字符串



Msg

提示信息

字符串



biz_data

接口提供方返参

字符串


部分参数使用AES对称加密

Ø 业务返回参数说明

参数代码

参数名称

参数类型

参数长度

是否必填

注释说明



















 

4.1.8. 接口实际返回示例

实际使用时加密以实际密钥参数为准。

结果返回实例(同步请求成功)

{"msg":"成功",

"code":"1",

"sub_msg":"",

"sub_code":"",

"biz_data":{"msg":"成功","code":200,"pages":null,"data":"ZiJlf2GERhPy6w7oGUCUVBNm2WffScBl\/jpVAXwVI6ZEMZ361NcTMkVfHRBxEUUAaxOxoXmi95xp\r\nvU6JPcemjl9MrgsfRE8tNnnHHTgxg9

Z4nVOqBZqZuAxzeZHEB9P+0eiNWMRukrZSPZ27kXRLC9GU\r\nbGN4m87nak\/IzJ33v0PARytY6g8UCDso8L6vQRnUbc3omOXNzq8ccxi8zsJpGU8tlyabeYk7F2NO\r\nVPgLXx3cMhWbMWonFm8+M0Vi4jthheIsFYK0HEhk2LqGjB85lHCv9HBnVF\/c46Ax+PU0DwYIyhmr\r\noKSaYDxm54xLctJ1cufCjW8LOPP1rksSWUFD8dPiAhkQI8c2hwL\/DczUsezHf5qKsnnALN++8OaW\r\ntV5mSz\/LRQi1TZWq8qFyLCI5kZtuXt9M5fzWpSPPvpICS5n6WH8Vlaef0OPUYNJrvS7OCWO1+1gf\r\nrS8VbKXJHKGixlBC7p+vWCJm25BEgNZPkq2943Ywul1JX9ykCmYRWe2pyyqUHYvxn0oZwmF2XOGk\r\nCt2w8PokgG4sBaQL\/aa+hRCZFbWQ4oahK8yqdCWpB7K2tG\/uCtPfMQXjToT612d5PBOC5e9eBAUf\r\nLoT7GvpZa\/uGtHb8Ia4LavayfDTSa7Es6RHvGUu80v4hPxHGl0cb\/k62fabTnxepjhOGGW68\/m0A\r\nYho9OT9n+FtedBdsE4UGJ3oW1i4Jf0lBxRSLZLqnDp2Gl5ezI8pz1\/J44LBP5pVegmMhCxMi1LA3\r\nISKkPhSZR0NzrUHarpFBPFUU5aglspDvy19UGWPKKJobFP1s1mIf6fbcA+lhFBYcJjiZlY9xNRU5\r\nHU8oPEINNytldPxASG4hUzfNG7CQv+jpPWWGF9dfqBqbFcMe0DuZsAsVGFx40GCEg18SzoCkrqu9\r\nTBYJA5wDhNSmYXgIHWt9ZrnPILLXEh1YhkKCuuWeGt+L30X9XHccxjflPwkbdKCY1mfWGqXh53yX\r\ng6ibY4YElgZVySXMCT0vWuDA7PqFM03+Z\/UNOmBZKZtwEcOo+CgC9vR3LeghUEKEVi3rzKVjecdR\r\nMzRVPVPgVEeSirzB5Ihxf9IEDyw2i5+0TLx942OtmjqK31I81Yw2wrxMleYY3XMvDBAQ\/W8PgE6h\r\ni2jjmxkyQaoN4WvRCuyC5NXzqGjKttmA51j6177LHMgnQ6bm6N1+KC8ww1\/W62GyiIDlheF4VKHF\r\nXnPFlrtE2GaYdkI72tdbmA==","records":null,"timestamp":1587021622464}}

结果返回实例(失败)

{

    "code":"-300",

    "msg":"执行错误",

    "sign":"xxxx",

    "biz_data":{

    }

}