DB21_T+4046—2024公共数据开放平台接入技术规范.docx
目次前言III1范围12规范性引用文件13术语和定义14接入技术要求24.1接入总体框架示意图24.2网络环境要求24.3接入要求34 .3.1目录接入35 .3.2资源接入34.4接入流程31.1.1 1未建开放平台接入流程要求31.1.2 已建开放平台接入流程要求31.1.3 前置库数据接入流程要求31.1.4 前置机准备阶段41.1.5 数据抽取阶段51.1.6 数据质量确认阶段51.1.7 数据挂载阶段55接口规范要求55.1接口基本要求55.1.1通讯协议55.1.2消息头55.1.3消息体65.1.4返回内容65.2接口设计描述65.2.1数据目录接入描述65.2.2数据资源接入描述66安全措施要求66.1平台安全要求6表C.5(续)提交数据举例,z,resu1.tStatusCodez,:code:1,description:1,''contactName:测试者,,zcontactPhonez,:“13344445555,,zcontactEmai1,z:zz799816459qq.COn,Ca1.1.1.ype:rest,“endpoint:http:127.0.0.1:9980/resource/admin/resource/apiDefinePagez,timeout:1,“restReqUeStMethod:get返回HTTP状态200返回数据参数名称类型字符长度描述codestring4执行结果代码msgstring128执行结果信息dataarray-执行结果数据集返回数据举例(处理正常)(COde:OoO1,msg:处理成功)C.6服务资源撤销接口示例服务资源撤销接口示例见表C.6。表C.6服务资源撤销接口示例名称服务资源撤销接口功能说明市数据开放平台将服务资源撤销同步到省数据开放平台UR1.样式apiv1.service提交方式DE1.ETE接口协议HTTP+JS0N内容类型app1.ication/json提交HTTPHeader数据名称是否必须类型字符长度描述opendata_uid是string32请求者身份标识opendata_ctime是string10服务调用时间opendata_sign是string32签名信息提交资源数据名称是否必须类型字符长度描述service1.d是string32服务上报时,省级平台返回的服务id提交数据举例“service1.d:,z062240b20e0a4caea24f5b451d003354z,返回HTTP状态200返回数据参数名称类型字符长度描述codestring4执行结果代码msgstring128执行结果信息dataarray-执行结果数据集返回数据举例(处理正常)(Code:OoO1,msg:处理成功C.7服务资源附件上传接口服务资源附件上传接口见表C.7。表C.7服务资源附件上传接口名称服务资源附件上传接口功能说明市数据开放平台将服务资源附件上传同步到省数据开放平台UR1.样式apiv1.servicefi1.e提交方式POST接口协议HTTP+JSON内容类型app1.ication/json提交HTTPHeader数据名称是否必须类型字符长度描述opendatauid是string32请求者身份标识opendata_ctime是string10服务调用时间opendata_sign是string32签名信息提交资源数据名称是否必须类型字符长度描述service1.d是string32服务iddocName是string100文件名称docSize是int11文件大小docFormat是string32文件类型docFi1.e是fi1.e-文件提交数据举例(,zservice1.dzz:,z062240b20e0a4caea24f5b451d003354,z,“docName:*第四次全国经济普查公报,“docSize:123,11.上docrormat:zip,"docFi1.e:文件名称.zip返回HTTP状态200返回数据参数名称类型1字符长度描述codestring4执行结果代码msgstring128执行结果信息dataarray执行结果数据集doc1.dstring32文件id返回数据举例(处理正常)(“code:OOO1,InSg:处理成功,data:“doc1.d:,6c5f8a86cd8a43ddab456889d55d6265z,C.8服务资源附件删除接口服务资源附件删除接口见表C.8。表C.8服务资源附件删除接口名称服务资源附件删除接口功能说明市数据开放平台将服务资源附件删除同步到省数据开放平台UR1.样式apiv1.service/fi1.e提交方式DE1.ETE接口协议HTTP+JS0N内容类型app1.ication/json提交HTTPHeader数据名称是否必须类型字符长度描述opendata_uid是string32请求者身份标识opendata_ctime是string10服务调用时间opendata_sign是string32签名信息提交资源数据名称是否必须类型字符长度描述ServiceId是string32服务上报时,省级平台返回的服务iddocId是string32文件id提交数据举例("service1.d":"062240b20e0a4caea24f5b451d003354”,doc1.d,z:,062240b20e0a4caea24f5b451d003354,z)返回HTTP状态200返回数据参数名称类型字符长度描述codestring4执行结果代码msgstring128执行结果信息dataarray执行结果数据集docIdstring32文件id返回数据举例(处理正常)("code:OoO1,InSg:处理成功,data:doc1.d:"6c5f8a86cd8a43ddab456889d55d6265,z)C.9链接资源注册接口链接资源注册接口见表C9。表C.9链接资源注册接口名称链接资源注册接口功能说明市数据开放平台将链接资源注册到省数据开放平台UR1.样式apiv1.ur1.提交方式POST接口协议HTTP+JSON内容类型appIication/json提交HTTPHeader数据名称是否必须类型字符长度描述opendata_uid是string32请求者身份标识opendata_ctime是string10服务调用时间opendata_sign是string32签名信息提交资源数据名称是否必须类型字符长度描述ur1.Name是string60链接名称dataUr1.是string160链接地址Ur1.Description是string200链接描述cataid是string32目录id提交数据举例(“ur1.Name:*门户网站,z,dataUr1.z,:http:WWw.*.gov.Cr,“Ur1.DescriptiorT:此链接指向*门户网站首页,,zcata1.dz,:6c5f8a86cd8a43ddab456889d55d6265)返回HTTP状态200返回数据参数名称类型字符长度描述codestring4执行结果代码msgstring128执行结果信息dataarray-执行结果数据集ur1.1.dstring32链接id返回数据举例(处理正常)"code":"0001”,"msg":"处理成功”,data:"ur1.1.d,z:,z6c5f8a86cd8a43ddab456889d55d6265"C.10链接资源变更接口链接资源变更接口见表C.10。表C.10链接资源变更接口名称链接资源变更接口功能说明市数据开放平台将链接资源变更同步到省数据开放平台UR1.样式apiv1.ur1.提交方式PUT接口协议HTTP+JSON内容类型app1ication/json提交HTTPHeader数据名称是否必须类型字符长度描述opendata_uid是string32请求者身份标识opendata_ctime是string10服务调用时间opendata_sign是string32签名信息提交资源数据名称是否必须类型字符长度描述ur1.1.d是string32链接idur1.Name是string60链接名称dataUr1.是string160链接地址Ur1.Description是string200链接描述cataid是string32目录id提交数据举例(,ur1.id":,ca4f25667e534ef0a7d5c7cb77e35e87z,“ur1.Name”:*门户网站,dataUr1.:http:www.*,urIDeScriptiorT:此链接指向*门户网站首页,,zcata1.d,z:zz6c5f8a86cd8a43ddab456889d55d6265z,返回HTTP状态200返回数据参数名称类型r字符长度描述codestring4执行结果代码msgstring128执行结果信息返回数据举例(处理正常)