目录管理系统-接口需求规格说明

目录管理系统接口需求规格说明修订记录版本号作者日期修订说明V1.02018.12.10初稿 目录1. 引言 -1-1.1 系统概述 -1-1.2 文档概述 -1-2. 引用文件 -2-3. 需求 -3-3.1 接口标识和接口图 -3-3.1.1 东方通数据交换平台对接 -3- 目录列表查询接口 -3- 交换资源推送接口 -4- 目录资源数据推送接口 -4-3.1.2 统一管理平台对接 -5- 接口授权 -5- 用户增加接口 -6- 用户修改接口 -7- 用户删除接口 -8- 部门增加接口 -8- 部门修改接口 -9- 部门删除接口 -10- 菜单列表查询接口 -11- 菜单角色添加接口 -11-0 菜单角色修改接口 -12-1 菜单角色删除接口 -13-2 菜单分类角色查询接口 -14-3 用户权限添加接口 -14-3.2 接口说明 -15-3.2.1 东方通数据交换平台对接 -15- 目录列表查询接口 -15- 交换资源推送接口 -16- 目录资源数据推送接口 -18-3.2.2 统一管理数据对接 -19- 接口授权 -19- 用户增加接口 -19- 用户修改接口 -20- 用户删除接口 -21- 部门增加接口 -21- 部门修改接口 -22- 部门删除接口 -23- 菜单列表查询接口 -23- 菜单角色增加接口 -24-0 菜单角色修改接口 -25-1 菜单角色删除接口 -25-2 目录分类角色查询接口 -26-3 用户权限添加接口 -26-4. 合格性规定 -28-引言系统概述通过政务信息资源目录管理系统用于规范政务部门政务信息资源目录的编制和国家政务信息资源目录的汇总编制，方便政务信息资源管理、共享和发布等工作。根据相关技术规范的要求，政务信息资源目录管理系统功能的主要功能包括信息资源编目、目录导出、目录汇集、目录发布等。文档概述本文档主要用于政务信息资源目录系统与东方通数据交换平台系统对接，政务信息资源目录系统与统一管理平台系统对接。引用文件《计算机软件开发规范》（GB/T8566-2007）《计算机软件产品开发文件编制指南》（GB/T8567—2006）《软件工程术语》（GB/T11457—2006）《计算机软件配置管理计划规范》（GB/T12260-90）《计算机软件质量保证计划规范》（GB/T12504-90）《政务信息资源目录管理系统-软件需求规格说明书》需求接口标识和接口图接口访问地址为：通过URL地址进行访问接口协议为：HTTP+JSON。方法为：POST。GetResourcePlatToken请求通过应用密钥获取用户授权的唯一票据，通过传递唯一票据对其他接口进行操作。东方通数据交换平台对接目录列表查询接口当需要获取目录资源列表时，数据交换平台调用政务资源管理系统提供的“获取目录资源列表接口”，获取目录资源列表。1）接口标准及规范标识getCatalogListByPage接口使用流程图图3.1接口使用流程图2）接口使用流程说明用户认证数据交换平台发起调用服务申请，目录管理平台对发起申请调用的平台进行身份认证，认证通过后才能进行下一步校验，否则返回相应的错误码。权限校验数据交换平台通过认证后，在调用相应的接口前，目录管理平台会对数据交换平台进行相应的权限验证，如果没有相应的获取及修改权限，则返回相应的错误码。交换资源推送接口当交换系统注册资源并发布成功后，交换系统平台调用政务信息资源目录平台提供的“交换资源推送接口”把资源推送给政务信息资源目录管理系统。1）接口标准及规范标识resourceInfoPush接口使用流程图图3.1接口使用流程图2）接口使用流程说明用户认证数据交换平台发起调用服务申请，目录管理平台对发起申请调用的平台进行身份认证，认证通过后才能进行下一步校验，否则返回相应的错误码。权限校验数据交换平台通过认证后，在调用相应的接口前，目录管理平台会对数据交换平台进行相应的权限验证，如果没有相应的获取及修改权限，则返回相应的错误码。目录资源数据推送接口当交换系统注册资源并发布成功后，如果资源类型是数据库类型，则调用政务信息资源目录平台提供的“目录资源数据推送接口”把资源推送给政务信息资源目录管理系统。1）接口标准及规范标识tableColumnInfoPush接口使用流程图图3.1接口使用流程图2）接口使用流程说明用户认证数据交换平台发起调用服务申请，目录管理平台对发起申请调用的平台进行身份认证，认证通过后才能进行下一步校验，否则返回相应的错误码。权限校验数据交换平台通过认证后，在调用相应的接口前，目录管理平台会对数据交换平台进行相应的权限验证，如果没有相应的获取及修改权限，则返回相应的错误码。统一管理平台对接接口授权1）接口标准及规范标识BeginLogin接口使用流程图图3.1接口使用流程图2）接口使用流程说明用户认证统一管理平台发起调用服务申请，目录管理平台对发起申请调用的平台进行身份认证，认证通过后才能进行下一步校验，否则返回相应的错误码。权限校验统一管理平台通过认证后，在调用相应的接口前，目录管理平台会对数据统一管理平台进行相应的权限验证，如果没有相应的获取及修改权限，则返回相应的错误码。用户增加接口当对用户有新增需求时，统一管理平台调用政务信息资源目录平台提供的“用户增加接口”，添加用户。1）接口标准及规范标识addUser接口使用流程图图3.1接口使用流程图2）接口使用流程说明用户认证统一管理平台发起调用服务申请，目录管理平台对发起申请调用的平台进行身份认证，认证通过后才能进行下一步校验，否则返回相应的错误码。权限校验统一管理平台通过认证后，在调用相应的接口前，目录管理平台会对数据统一管理平台进行相应的权限验证，如果没有相应的获取及修改权限，则返回相应的错误码。用户修改接口当对用户信息有修改需求时，统一管理平台调用政务信息目录资源平台提供的“用户修改接口”，修改用户信息。1）接口标准及规范标识updateUser接口使用流程图图3.1接口使用流程图2）接口使用流程说明用户认证统一管理平台发起调用服务申请，目录管理平台对发起申请调用的平台进行身份认证，认证通过后才能进行下一步校验，否则返回相应的错误码。权限校验统一管理平台通过认证后，在调用相应的接口前，目录管理平台会对数据统一管理平台进行相应的权限验证，如果没有相应的获取及修改权限，则返回相应的错误码。用户删除接口当对用户信息有删除需求时，统一管理平台调用政务信息资源目录管理平台提供的“用户删除接口”，删除用户信息。1）接口标准及规范标识deleteUser接口使用流程图图3.1接口使用流程图2）接口使用流程说明用户认证统一管理平台发起调用服务申请，目录管理平台对发起申请调用的平台进行身份认证，认证通过后才能进行下一步校验，否则返回相应的错误码。权限校验统一管理平台通过认证后，在调用相应的接口前，目录管理平台会对数据统一管理平台进行相应的权限验证，如果没有相应的获取及修改权限，则返回相应的错误码。部门增加接口当对部门有增加需求时，统一管理平台调用政务信息资源目录平台提供的“部门增加接口”，添加部门。1）接口标准及规范标识AddDepartment接口使用流程图图3.1接口使用流程图2）接口使用流程说明用户认证统一管理平台发起调用服务申请，目录管理平台对发起申请调用的平台进行身份认证，认证通过后才能进行下一步校验，否则返回相应的错误码。权限校验统一管理平台通过认证后，在调用相应的接口前，目录管理平台会对数据统一管理平台进行相应的权限验证，如果没有相应的获取及修改权限，则返回相应的错误码。部门修改接口当对部门有修改需求时，统一管理平台调用政务信息资源目录平台提供的“部门修改接口”，修改部门。1）接口标准及规范标识updateDept接口使用流程图图3.1接口使用流程图2）接口使用流程说明用户认证统一管理平台发起调用服务申请，目录管理平台对发起申请调用的平台进行身份认证，认证通过后才能进行下一步校验，否则返回相应的错误码。权限校验统一管理平台通过认证后，在调用相应的接口前，目录管理平台会对数据统一管理平台进行相应的权限验证，如果没有相应的获取及修改权限，则返回相应的错误码。部门删除接口当对部门有删除需求时，统一管理平台调用政务信息资源目录平台提供的“部门删除接口”，删除部门。1）接口标准及规范标识DeleteDepartment接口使用流程图图3.1接口使用流程图2）接口使用流程说明用户认证统一管理平台发起调用服务申请，目录管理平台对发起申请调用的平台进行身份认证，认证通过后才能进行下一步校验，否则返回相应的错误码。权限校验统一管理平台通过认证后，在调用相应的接口前，目录管理平台会对数据统一管理平台进行相应的权限验证，如果没有相应的获取及修改权限，则返回相应的错误码。菜单列表查询接口当需要获取菜单列表时，统一管理平台调用政务信息资源目录平台提供的“菜单列表查询接口”，获取政务平台菜单信息。1）接口标准及规范标识QueryMenuList接口使用流程图图3.1接口使用流程图2）接口使用流程说明用户认证统一管理平台发起调用服务申请，目录管理平台对发起申请调用的平台进行身份认证，认证通过后才能进行下一步校验，否则返回相应的错误码。权限校验统一管理平台通过认证后，在调用相应的接口前，目录管理平台会对数据统一管理平台进行相应的权限验证，如果没有相应的获取及修改权限，则返回相应的错误码。菜单角色添加接口当对菜单角色有新增需求时，统一管理平台调用政务信息资源目录平台提供的“菜单角色添加接口”，添加菜单角色信息。1）接口标准及规范标识AddMenuCharacter接口使用流程图图3.1接口使用流程图2）接口使用流程说明用户认证统一管理平台发起调用服务申请，目录管理平台对发起申请调用的平台进行身份认证，认证通过后才能进行下一步校验，否则返回相应的错误码。权限校验统一管理平台通过认证后，在调用相应的接口前，目录管理平台会对数据统一管理平台进行相应的权限验证，如果没有相应的获取及修改权限，则返回相应的错误码。菜单角色修改接口当对菜单角色有修改需求时，统一管理平台调用政务信息资源目录平台提供的“菜单角色修改接口”，修改菜单角色信息。1）接口标准及规范标识ModifyMenuCharacter接口使用流程图图3.1接口使用流程图2）接口使用流程说明用户认证统一管理平台发起调用服务申请，目录管理平台对发起申请调用的平台进行身份认证，认证通过后才能进行下一步校验，否则返回相应的错误码。权限校验统一管理平台通过认证后，在调用相应的接口前，目录管理平台会对数据统一管理平台进行相应的权限验证，如果没有相应的获取及修改权限，则返回相应的错误码。菜单角色删除接口当对菜单角色有删除需求时，统一管理平台调用政务信息资源目录平台提供的“菜单角色删除接口”，删除菜单角色信息。1）接口标准及规范标识DeleteMenuCharacter接口使用流程图图3.1接口使用流程图2）接口使用流程说明用户认证统一管理平台发起调用服务申请，目录管理平台对发起申请调用的平台进行身份认证，认证通过后才能进行下一步校验，否则返回相应的错误码。权限校验统一管理平台通过认证后，在调用相应的接口前，目录管理平台会对数据统一管理平台进行相应的权限验证，如果没有相应的获取及修改权限，则返回相应的错误码。菜单分类角色查询接口当需要获取菜单分类角色列表时，统一管理平台调用政务信息资源目录平台提供的“菜单分类角色列表查询接口”，获取政务平台菜单分类角色信息。1）接口标准及规范标识QueryUserAuthorization接口使用流程图图3.1接口使用流程图2）接口使用流程说明用户认证统一管理平台发起调用服务申请，目录管理平台对发起申请调用的平台进行身份认证，认证通过后才能进行下一步校验，否则返回相应的错误码。权限校验统一管理平台通过认证后，在调用相应的接口前，目录管理平台会对数据统一管理平台进行相应的权限验证，如果没有相应的获取及修改权限，则返回相应的错误码。用户权限添加接口当需要添加用户权限时，统一管理平台调用政务信息资源目录平台提供的“用户权限添加接口”，添加用户权限。1）接口标准及规范标识AddUserRightsAssignment接口使用流程图图3.1接口使用流程图2）接口使用流程说明用户认证统一管理平台发起调用服务申请，目录管理平台对发起申请调用的平台进行身份认证，认证通过后才能进行下一步校验，否则返回相应的错误码。权限校验统一管理平台通过认证后，在调用相应的接口前，目录管理平台会对数据统一管理平台进行相应的权限验证，如果没有相应的获取及修改权限，则返回相应的错误码。接口说明东方通数据交换平台对接接口访问统一风格为HTTP+接口地址+项目名称+接口名+标识名。接口协议为HTTP+JSON，方法为POST请求，返回数据为JSON，JSON内对应返回数据类型都为String类型。目录列表查询接口方法名称publicObjectgetCatalogListByPage(HttpServletRequestrequest)接口方法参数需求表3.1目录列表查询接口序号参数名参数描述1methodGetCataLogByPage2page查询页码（分页参数）3regionId域ID4pageSize查询每页数量（分页参数）5cata_title目录标题（搜索参数）6status目录状态：0待配置2待发布3已发布4已上线5已下线如果不传表示查询所有状态也可用”,”号隔开查询多个状态7user_id统一认证用户id交换资源推送接口方法名称publicStringList<Map<String,Object>>map)接口方法参数需求表3.1交换资源推送接口序号参数名参数描述1id交换资源id2cata_id目录资源id3resourceName资源名称4resourceDesc资源备注5resourceType交换资源类型:1.table:表资源2.file:文件3.api:接口6orgName发布的机构7realResource真实资源1.表名2.文件路径8orgId发布的机构id9subTime发布的时间10userId用户标识11optype操作类型:1.add:新增2:update:修改3:delete：删除12status状态1.变更申请审核通过2.平台审核通过3.已发布4.撤销倒计时5.删除13regionId域id14systemId来源系统id15sharedType共享类型:1:无条件共享2:有条件共享3:不予共享16sharedCondition共享条件17publicType开放类型:1:向社会开放2:不向社会开放18publicCondition开放条件19ownerOrgName资源所属机构名称20ownerOrgId资源所属机构id21version版本号22delDesc撤销理由23updateDesc变更理由24updateCycle资源更新周期目录资源数据推送接口方法名称publicObjectList<Map<String,Object>>list)接口方法参数需求表3.1目录资源数据推送接口序号参数名参数描述1cata_id目录id2resource_id资源id3table_name表名4columns库表资源字段信息5name_cn信息项中文名6name_table信息项字段名7field_type字段类型8length字段长度9is_null_field是否为空，1：为空，0：不为空10is_pk_field是否主键，1：是，0：否11order_num排序统一管理数据对接接口授权方法名称publicvoidBeginLogin(HttpServletRequestrequest,HttpServletResponseresponse)接口方法参数需求序号参数名参数描述1LOGIN_NAME登录名2PASSWORD密码表3.1接口授权接口用户增加接口方法名称publicvoidaddUser(Map<String,Object>data,HttpServletResponseresponse,HttpServletRequestrequest)接口方法参数需求表3.1用户增加接口序号参数名参数描述1USER_ID用户ID(long)2TOKEN凭据3LOGINNAME登录名4USERNAME用户名5PASSWORD密码6SEX性别1-男0-女7TELEPHONE座机号8MOBILE手机号9MAIL邮箱用户修改接口方法名称publicvoidupdateUser(Map<String,Object>data,HttpServletResponseresponse,HttpServletRequestrequest)接口方法参数需求表3.1用户修改接口序号参数名参数描述1USER_NAME用户名2PASSWORD密码3SEX性别1-男0-女4TELEPHONE座机号5MOBILE手机号6MAIL邮箱7USER_ID新增用户返回的用户唯一标识8TOKEN凭据用户删除接口方法名称publicvoiddeleteUser(Map<String,Object>data,HttpServletResponseresponse,HttpServletRequestrequest)接口方法参数需求表3.1用户删除接口序号参数名参数描述1USER_ID新增用户返回的用户唯一标识2TOKEN凭据部门增加接口方法名称publicvoidAddDepartment(Map<String,Object>data,HttpServletResponseresponse,HttpServletRequestrequest)接口方法参数需求表3.1部门增加接口序号参数名参数描述1DEPT_ID部门ID(Long)2DEPTNAME部门名称3DESCRIPTION部门简述4PID上级部门id如没有上级部门:(所属部门为固定值2所属区县为固定值3)5QQNUM部门联系人QQ号6EMAIL部门联系人邮箱7PHONENUM部门联系人手机号8CONTACT部门联系人名子9ORDERNUM用户排序1为第一位以此类推10TOKEN凭据部门修改接口方法名称publicvoidupdateDept(Map<String,Object>data,HttpServletResponseresponse,HttpServletRequestrequest)接口方法参数需求表3.1部门修改接口序号参数名参数描述1TOKEN凭据2DEPT_ID部门唯一标识3DEPTNAME部门名称4DESCRIPTION部门简述5QQNUM部门联系人QQ号6EMAIL部门联系人邮箱7CONTACT部门联系人名子8ORDERNUM用户排序1为第一位以此类推部门删除接口方法名称publicvoidDeleteDepartment(Map<String,Object>data,HttpServletResponseresponse,HttpServletRequestrequest)接口方法参数需求表3.1部门删除接口序号参数名参数描述1TOKEN凭据2DEPT_ID部门唯一标识菜单列表查询接口方法名称publicvoidQueryMenuList(Map<String,Object>data,HttpServletResponseresponse,HttpServletRequestrequest)接口方法参数需求表3.1菜单查询接口序号参数名参数描述1TOKEN凭据2USER_ID用户ID3SYSTEM_ID系统ID：1.政务信息资源目录管理系统ID为12.政务信息采集系统ID为53.政务信息资源管理系统ID为4菜单角色增加接口方法名称publicvoidAddMenuCharacter(Map<String,Object>data,HttpServletResponseresponse,HttpServletRequestrequest)接口方法参数需求表3.1菜单角色添加接口序号参数名参数描述1TOKEN凭据2USER_ID用户ID3MENU_ID菜单ID,菜单ID,多个菜单ID用英文”,”分割4NAME角色名称5DESCRIPTION角色简述菜单角色修改接口方法名称publicvoidModifyMenuCharacter(Map<String,Ob