DB52T 1541.4-2021 政务数据平台 第4部分：接口规范

ICS01.040.03DB52贵州省市场监督管理局发布IDB52/T1541.4—2021 12规范性引用文件 13术语和定义 14缩略语 25基本要求 26接口组成 27接口要求 38接口安全 9附录A（资料性）认证授权服务接口JSONSchema示例 附录B（资料性）组织新增接口JSONSchema示例 附录C（资料性）用户新增接口JSONSchema示例 附录D（资料性）数据资源目录接口的接口信息JSONSchema示例 附录E（资料性）数据资源目录接口信息描述对象参数表 附录F（资料性）数据资源目录接口的目录信息JSONSchema描述示例 附录G（资料性）数据资源目录描述对象参数表 附录H（资料性）政务数据平台接口返回JSONSchema示例 附录I（资料性）政务数据平台接口返回参数表 本文件按照GB/T1.1-2020《标准化工作导则第1部分：标准化文件的结构和起草规则》州省信息中心、贵州省量子信息和大数据应用技术研究院。本文件主要起草人：朱小洪、宿睿智、刘彦嘉、王嘉卉、徐凯琳、田野、秦晓东、邵建平、潘伟杰、韩朱旸、冯丹妮、尚志刚、杨昶、李怡然、吴明娅、石睿、曾映菊、唐昶、张洋、姚茂峰、陆莹、孙瑾。1政务数据资源目录directory通过对政务数据资源依据规范的元数据描述，按照一定的分类方法进行排序和编码的一组信息,用政务数据提供方governmentdatap2API:应用程序编程接口(Applicatio曹善遭曹善遭认证提权阳芳新增接数据资源目录0用户接口组织接口03DB52/T1541.4—20217接口要求7.1认证授权服务接口接口描述：政务数据提供方接入政务数据平台应调用认证授权服务接口。通过平台认证授权服务接口进行身份验证，验证成功后接口返回的授权访问令牌，政务数据提供方操作政务数据平台接口应携带访问令牌，进行正常会话交互。接口地址：/api/auth_service。接口类型：post。请求参数：认证授权服务接口请求参数见表1。请求示例：见附录A。返回参数：见附录I表I.1。返回示例：见附录H。表1认证授权服务接口请求参数表是是是是7.2组织接口7.2.1组织新增接口接口描述：政务数据提供方调用政务数据平台组织新增接口，获取政务数据平台返回的组织ID，根据组织ID进行政务数据提供方系统和政务数据平台交互。接口地址：/api/add/organization。接口类型：post。请求参数：同步组织机构请求参数见表2。请求示例：见附录B。返回参数：见附录I表I.1。返回示例：见附录H。表2同步组织机构请求参数表是是是是是是是是4DB52/T1541.4—20217.2.2组织编辑接口接口描述：编辑组织机构信息。接口地址：/api/add/organization。接口类型：post。请求参数：组织机构编辑请求参数见表3。请求示例：见附录B。返回参数：见附录I表I.1。返回示例：见附录H。表3组织机构编辑请求参数表是是是是是是是是7.2.3组织查询接口接口描述：政务数据提供方查询政务组织机构信息。接口地址：/api/organization/query。接口类型：get。请求参数：组织机构查询接口请求参数见表4。请求示例：http://ip+port/api/organization/query?org_name=组织名称&org_id=z6lqTzG3PTPpQIE92Bs0pA3PSyVJmlWM。返回参数：见附录I表I.1。返回示例：见附录H。表4组织机构查询接口请求参数表是是7.3用户接口7.3.1用户新增接口接口描述：政务数据提供方调用用户新增接口，同步组织机构用户信息到政务数据平台。接口地址：/api/add/user。接口类型：post。请求参数：组织机构用户新增请求参数见表5。5DB52/T1541.4—2021请求示例：见附录C。返回参数：见附录I表I.1。返回示例：见附录H。表5组织机构用户新增请求参数表是是是是否是7.3.2用户编辑接口接口描述：政务数据提供方编辑政务组织机构用户信息。接口地址：/api/add/user。接口类型：post。请求参数：组织机构用户编辑请求参数见表6。请求示例：见附录C。返回参数：见附录I表I.1。返回示例：见附录H。表6组织机构用户编辑请求参数表是是是是是7.3.3用户查询接口接口描述：政务数据提供方查询政务数据平台组织机构用户信息。接口地址：/api/query/user。接口类型：get。请求参数：用户查询见请求参数表7。请求示例：http://ip+port/api/user/query?userId=z6lqTzG3PTPpQIE92Bs0pA3PSyVJmlWM。返回参数：见附录I表I.1。返回示例：见附录H。表7用户查询请求参数表是6DB52/T1541.4—20217.4数据资源目录接口7.4.1数据资源目录新增接口接口描述：政务数据提供方同步政务组织机构的数据资源目录信息到政务数据平台。接口地址：/api/add/resource。接口类型：post请求参数：数据资源目录新增请求参数见表8。请求示例：见附录D。返回参数：见附录I表I.1。返回示例：见附录H。表8数据资源目录新增请求参数表是是是是是是是是是是开放属性：1有条件开放；2无条件开是是共享属性：1有条件共享；2无条件共享；是是78说明是是是是是9DB52/T1541.4—2021返回参数：见附录I表I.1。返回示例：见附录H。表10数据资源目录查询请求参数表是是8接口安全8.1对请求的合法性进行校验。8.2对请求的数据进行校验。8.3对请求实现黑明单与白名单拦截。8.4对请求实现用户使用接口的流量限制。DB52/T1541.4—2021（资料性）认证授权服务接口JSONSchema示例下面给出认证授权服务接口JSONSchema示例。{"$schema":"/draf"$id":"/ex{"app_key":"C3kFcJP5Pw5w13nBX2GCh0"app_secret":"rmnnkSkWfx0A7w6n13bK}"password"}DB52/T1541.4—2021（资料性）组织新增接口JSONSchema示例下面给出组织新增接口JSONSchema示例。{"$schema":"/draf"$id":"/ex"description":"Ther{"trustNo":"91370200"orgPostNo":"KXRay9t}}DB52/T1541.4—2021（资料性）用户新增接口JSONSchema示例下面给出用户新增接口JSONSchema示例。{"$schema":"/draft"$id":"/ex"description":"Ther{"mobile":"KXRay9teJN0V93kvgk""mobile"}DB52/T1541.4—2021（资料性）数据资源目录接口的接口信息JSONSchema示例数据资源目录接口的接口信息JSONSchema示例。{"$schema":"/draf"$id":"/ex"description":"Ther{"requestDemo":"?pageIndex=1&{}{DB52/T1541.4—2021}{}}DB52/T1541.4—2021（资料性）数据资源目录接口信息描述对象参数表数据资源目录接口信息描述对象参数表见表E.1。表E.1数据资源目录接口信息描述对象参数表是是是是是是是是是是是是DB52/T1541.4—2021（资料性）数据资源目录接口的目录信息JSONSchema描述示例下面给出数据资源目录接口的目录信息JSONSchema描述示例。{"$schema":"/draf"$id":"/e"description":"Therootschema"description":"Anexpla{{"type":"varchar""systemId":"710b8d8c-e868-4b55-9e4d}DB52/T1541.4—2021}}DB52/T1541.4—2021（资料性）数据资源目录描述对象参数表数据资源接口描述对象参数表见表G.1。表G.1数据资源目录描述对象参数表是是是DB52/T1541.4—2021（资料性）政务数据平台接口返回JSONSchema示例下面给出政务数据平台