《数据宝前置服务接口说明接口调用说明书版本V2.docx》由会员分享,可在线阅读,更多相关《数据宝前置服务接口说明接口调用说明书版本V2.docx(13页珍藏版)》请在第一文库网上搜索。
1、数据宝前置服务接口说明接口调用说明书版本:V2.2温州市大数据管理局修订记录修订版本号修订时间作者审核者修订内容1.02023-08-17何桂清文档创建2.02023-11-26何桂清新增第三方机构注册、创建业务接口2.12023-11-29何桂清接口1.5修改参数注解2.22023-11-29何桂清接口1.5修改入参、出参;新增查询第三方业务清单接口接口调用说明书目录-接入规范错误!未定义书签。1.1 使用说明错误!未定义书签。1.2 获取TOKEN错误!未定义书签。1.2.1 地址错误!未定义书签。1.2.2 功能错误!未定义书签。1.2.3 请求方式错误!未定义书签。1.2.4 请求内容
2、错误!未定义书签。1.2.5 返回结果错误!未定义书签。1.3 刷新TOKEN错误!未定义书签。1.3.1 地址错误!未定义书签。1.3.2 功能错误!未定义书签。1.3.3 请求方式错误!未定义书签。1.3.4 请求内容错误!未定义书签。1.3.5 返回结果错误!未定义书签。1.4 请求数据列表接口错误!未定义书签。1.4.1 地址错误!未定义书签。1.4.2 功能错误!未定义书签。1.4.3 请求方式错误!未定义书签。1.4.4 请求内容错误!未定义书签。1.4.5 返回结果错误!未定义书签。1.5 第三方机构入驻接口错误!未定义书签。1.5.1 地址错误!未定义书签。1.5.2 功能错误
3、!未定义书签。1.5.3 请求方式错误!未定义书签。1.5.4 请求内容错误!未定义书签。1.5.5 返回结果错误!未定义书签。1.6 测试错误!未定义书签。1.6.1 GET,TOKEN错误!未定义书签。1.6.2 REFRESH,TOKEN错误!未定义书签。1.7 错误响应码列表错误!未定义书签。-.接入规范需要提供调用接口的服务器的对外访问IP地址,以用于IP访问的限制。传输统一使用IJTF-8编码。1.1 使用说明用户有用户名和密码,使用用户名和密码调用接口https:/IP/openapi/get_token来获取令牌token,也可用这个接口刷新token,token失效后只能用这
4、个逐口重新获取。也可在token失效前用原来的token调用接口https:IP/openapi/rofr。Shtoken来刷新token。如果需要并发访问的,必须将token保存到公用区域(如redis内存数据库等),供并发进程共享。否则并发进程之间容易发生token冲突。USername:请向平台管理人员申请注册。Password:请向平台管理人员申请注册。1.2 获取TOKEN1.2.1 地址https:/IP/openapi/get_token1.2.2 功能可使用本接口来获取token或刷新,有效期为15分钟。1.2.3 请求方式POST1.2.4 请求内容请求参数说明:参数名注释u
5、sername银行账号用户名password银行账号密码1.2.5 返回结果“token”:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXxx”错误信息:error,:xxxx,xxxx,1.3 刷新TOKEN1.3.1 地址https:/IP/openapi/refresh_token1.3.2 功能在token秘钥过期前,可使用本接口来刷新token,有效期为15分钟。1.3.3 请求方式POST1.3.4 请求内容请求参数说明:token放在header1.3.5 返回结果“token:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXxxxxx”错
6、误信息:error,:xxxx,xxxx,1.4 请求数据列表接口1.4.1 地址https:IP/openopi/retrieveitemIiSt1.4.2 功能获取数据宝中所有在用且可以开放给其他系统的数据项清单1.4.3 请求方式POST1.4.4 请求内容token放headerParamsAuthorizationHeaders(11)BodyPre-requestScnptTestsSettingsHeadersiohiddenKeVVAWEjwt加空格再拼接tokenQAuthorizationjwteyOeXAiOiJKV1Qi1QhbGdOiJIUz11NiJ9.eyj1c2
7、VyX21k1jo2OSKeyVa1ueResponse1.4.5 返回结果-resu1t:OK,data,:,UUid:*bff7a092-a668-4887-964e-969c768c4586,type:个人证IT,name:居民户口3,temp1ate:”性别”,”曾用名“,“身份证号码”,“户类型”,“与户主关系”,“民旗“,“出生日期”,”出生地”,mm,“户所在地”,“所属派出所”,“注谓惊识”UUid:3c9b1b68-3f2a-4551-a01-f644e393f2d,typeo:个人证黑,1.5第三方机构注册.创建业务接口1.5.1 地址https:IP/opc/opi/rC
8、giStCrthirdParty1.5.2 功能传入所需参数,自动注册第三方对接用户账号,配置权限,并创建业务1.5.3 请求方式POST1.5.4 请求内容HeaderAuthorization”:tokenParamsAuthorizationHeaders(11)BodyPre-requestScnptTestsSettingsHeaders10hiddenkeyVA1UEjwt加空格再拼接token01QAuthorizationjwteyJ0eXAOJKV1Q1CJhbGOIJIUz11NIJ9.eyJ1c2VyX211djo2OSKeyVa1ueDReSPOnSeBody参数名注释
9、sign签名post_data请求参数Gson格式字符串)-rea1_name接入单位(系统)名称-uniscid接入单位(系统)统一社会信用代码-mobi1e_phone对接负责人手机号码-ipjimit接入IP限制,英文“;”连接-hourjimit每小时最大访问次数默认1000,不超过10000-dayjimit每天最大访问次数默认10000,不超过100000-biz_max_duration业务持续时间,最长不超过360,默认30-biz_name业务名称-ItemJist值为1.4接口获取到的数据项UUid列表-pub.key接入单位公钥(1024位)不带头尾BEGINPUB1IC
10、KEYENDPUB1ICKEY-postdata示例,post_data=Brea1_name:.第三方接入测试账号O01,#接入单位(系统)名称uniscid:xxxx,#企业统一信用代码证mobi1e_phone:13333333333,#对接负责人手机号码wip-1imit:127.0.0.1;127.0.0.1,#接入IP地址hour_1imit:2000#int每小时SI大访问次数默认IOooday-1imit-:20000,#int每天最大访问次数默认IOOOObiz_max_durations360,#业务持续时间,最长不超过360,默认30biz_name:第三方接入浦试假号0
11、01测试业务“,#接入业务名称item_1ist:(bff7a092-a668-4887-964e-969c768c4586z-6f22c830-b776-11e9-993e-38baf883ef31,#所需数据项清单,传接口1返回的UUid集合,不超过十顼pub_key:MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC5rQECnWB15fB,卜接入单位公钥(1024位)不带头尾BEGINPUB1ICKEYENDPUB1ICKEY1.5.5 返回结果,resu1t:success,data:msg:注册成功,password*:password1.6.1 地址h
12、ttps:IP/openopi/retrievebizIiSt1.6.2 功能根据统一社会信用代码,查询当前用户业务清单1.6.3 请求方式POST1.6.4 请求内容Header:“Authorization”:token)Body:参数名注释uniscid统一社会信用代码1.6.5 返回结果resu1t:,0K,fdata:biz_name:泰(“,biz_uuid:,2.P002,biz_max_duration1:360,item-1ist:”居民户口簿”,“不动产抵押信息”,“婚姻登记信息”,“机动车行驶证”,“不动产权证”,“企业法人信息”,“个人未履行生效判决信息”,“个人诚信分
13、(瓯江分)”,“公积金缴存信息”,“个人社保参保证明”1.7.1get-token(token-:、y】XMOnKVIQnCIhbGCen1UHIm”.41k2VyX21kI5MYFuayBI4cCI6MT20TcxMjIxM1wW37Z19pYXQ10jeiNjk4MTAeKT.aIgYS1AAPvqgendMS4h1K061GQ4ojOFy.Q)1.7.2refresh-tokenjw诟面是一个空格,再跟上之前获得的tokenTemporaryHeaders(8)。SUtus200OKm5Sae4IG8刷新荻得的新tokenPrettyRawProKcwVwzrmtaHTM15(-resu
14、1t:CX-,tokn-:ey)eeXAi0KV1Qi1C)htci01UzI1ND9.ey91.1工WybFtZ5I6IWzYMU”1siW416KTU20TW火4Mbdb3JpZ19pYXQiojEIMJWMTAeKTJ9MP1zjp)B1uaxZG0S.8ho6pscMbSKhJyjE86sBTca*f1.8错误响应码列表Tip:顺序按错误响应码排列与接口无关错误响应码错误信息9001路由不存在或无权限9002用户未认证9003系统错误,请联系管理员0001暂无业务0002用户名或密码错误0003无密钥0004json格式错误0005签名不正确0006token错误0007权限不足0008己授权0009拒绝授权0010有数据项未