DB52∕T 1261-2018 政务云 贵州省电子政务网 应用平台接入规范 50页

ICS01.040.03A12DB52贵州省地方标准DB52/T1261—2018政务云贵州省电子政务网应用平台接入规范2018-04-16发布2018-10-16实施贵州省质量技术监督局发布\n\nDB52/T1261—2018目次前言................................................................................II1范围..............................................................................12术语和定义........................................................................13基本要求..........................................................................24接入要求..........................................................................25运维管理要求......................................................................4附录A（规范性附录）接入管理流程相关信息表..........................................6附录B（规范性附录）接口鉴权规范....................................................8附录C（规范性附录）基础通用服务接口设计...........................................11附录D（规范性附录）政务业务事项服务设计...........................................28附录E（规范性附录）返回代码对照表.................................................41附录F（规范性附录）服务设计规范...................................................42I\n\nDB52/T1261—2018前言本标准按照GB/T1.1-2009《标准化工作导则第1部分：标准的结构和编写》给出的规则起草。请注意：本文件的某些内容可能涉及专利，本文件的发布机构不承担识别这些专利的责任。本标准由贵州惠智电子技术有限责任公司提出并归口。本标准起草单位：贵州省人民政府办公厅、贵州省信息中心、贵州省标准化院、贵州惠智电子技术有限责任公司。本标准主要起草人：王红、彭玉新、王翔、候庆、罗国远、万鹏、刘俊凯、罗华洋、黎智坤、谭海东、姜琳、吴如富、张小权、折小荣、马静、王晓。II\n\nDB52/T1261—2018政务云贵州省电子政务网应用平台接入规范1范围本标准规定了贵州省电子政务网应用平台接入的基本要求、接入要求、运维管理要求。本标准适用于需要接入贵州省电子政务网应用平台的业务应用系统。2术语和定义下列术语和定义适用于本文件。2.1贵州省电子政务网贵州省电子政务网是由贵州省人民政府办公厅牵头统一建设的，面向全省各级政府及其部门，集协同工作、学习，加强内部管理、交流等功能为一体的全省政府系统行政办公总平台及总入口，是贵州省电子政务云的一个重要应用平台，其基于国家电子政务外网环境建设，功能定位主要是为全省政府系统公务人员提供信息资源共享、数据互联互通和联动办公服务。2.2政务服务开放平台贵州省电子政务网应用平台中专用于为本标准规范所定义的业务应用系统及服务进行管理的一个子系统。主要用于对需要接入贵州省电子政务网应用平台的业务应用系统、服务、服务提供方、服务使用方等各种要素信息进行流程化的管理维护。2.3业务应用系统贵州省电子政务网应用平台中接入的各种解决政务业务需求的软件系统。包括贵州省电子政务网应用平台中已有的基础办公系统、接入的其它第三方厂商软件系统等，但不包括平台底层支撑组件。2.4服务接入的业务应用系统中的某些功能利用技术接口的方式单独提供出来供其它业务应用系统调用的形式称为服务，例如发送工作文件服务、查询机构信息服务、监听接收和发送公文服务等等。1\nDB52/T1261—20182.5服务提供方提供完整业务应用系统或服务，并将业务应用系统及服务在政务服务开放平台中注册并发布的组织或机构。2.6服务使用方需要调用政务服务开放平台上发布的服务或业务应用系统的组织或机构。2.7平台运营方对贵州省电子政务网应用平台进行运维和管理服务的组织或机构。2.8业主单位在政务服务开放平台中注册的业务应用系统的直接责任单位。3基本要求3.1业务应用系统及服务应按4.4条进行注册。3.2业务应用系统应以贵州省电子政务网应用平台中的统一组织机构人员数据库作为基础数据实现机构人员数据共享。3.3业务应用系统应以贵州省电子政务网应用平台中的统一认证系统作为身份认证单点登录的入口。3.4业务应用系统应按本标准中相应技术接口服务规范向贵州省电子政务网应用平台推送操作日志、提醒消息、待办事项等与工作相关的人员行为数据信息。3.5服务提供方及业主单位应规范运维和管理接入的业务应用系统和服务，确保正常运行，不得影响到贵州省电子政务网应用平台的正常运转。4接入要求4.1接入网络要求贵州省电子政务网应用平台运行于国家电子政务外网，业务应用系统接入贵州省电子政务网应用平台应通过国家电子政务外网环境进行接入。4.2接入技术要求4.2.1服务提供方在提供服务技术接口时，应遵行以下接口要求：a)服务接口要求支持XML和JSON数据格式。XML遵行XML1.0第5版规范，JSON遵行RFC4627规范；并要求支持JAVA、PHP、Javascript、.NET等主流开发语言；b)服务接口要求支持SDK或API模式，并支持WebService或Restful两种接口方式，同时提供详细接口技术文档。2\nDB52/T1261—20184.2.2业务应用系统应兼容支持HTML5标准规范的现代浏览器，移动端应支持Android4.4以上版本。4.3接入技术支持4.3.1获取接口技术文档获取最新的接口技术文档有以下渠道：a)在贵州省电子政务网应用平台中下载；b)到贵州省政府办公厅电子政务处拷贝；c)通过联系贵州省电子政务网应用平台运营方获取。4.3.2获取技术支持统一由平台运营方运维团队提供技术支持，支持范围包括业务应用系统的注册、接入、发布流程、业务应用系统或服务订单管理、服务接口的测试发布、服务调用等技术类问题。4.4接入管理流程4.4.1总体流程描述业务应用系统在接入贵州省电子政务网应用平台时，总体上应按如下总体流程图进行操作，分为服务使用方、政务服务开放平台、服务提供方三种不同的角色进行定位，并分阶段描述了不同阶段不同角色要完成的事项和职责。图1流程图3\nDB52/T1261—20184.4.2服务提供方注册流程4.4.2.1服务提供方完整填写《业务系统注册基本信息表》（见附录A.1），相关人员单位签字用章后，提交给政务服务开放平台管理人员。4.4.2.2政务服务开放平台管理人员负责审批服务提供方提交业务系统注册基本信息，审批通过后配发业务应用系统负责人的登录账号密码给服务提供方的业务应用系统负责人。4.4.2.3业务应用系统负责人通过账号密码登录到政务服务开放平台进行后续操作。4.4.3服务提供方申请发布服务流程4.4.3.1业务应用系统注册基本信息审批通过后，服务提供方才可以进行申请发布服务的流程。4.4.3.2服务提供方完整填写《服务发布申请基本信息表》（见附录A.2），相关人员单位签字用章后，提交给政务服务开放平台管理人员，审批通过后可在政务服务开放平台中发布该服务。4.4.3.3要发布的服务的每一个服务接口都需要单独填写一份《服务接口内容信息表》（见附录A.3），提交给政务服务开放平台管理人员。4.4.4服务使用方申请使用业务应用系统或服务流程4.4.4.1申请业务应用系统使用时，完整填写《业务应用系统使用申请基本信息表》（见附录A.5）,提交给政务服务开放平台管理人员，审批通过后将由业务应用系统的服务提供方与申请单位联系后续开通使用事宜。4.4.4.2申请使用服务时，完整填写《服务使用申请基本信息表》（见附录A.4），提交给政务服务开放平台管理人员，审批通过后申请方按相关技术规范使用，使用过程中的技术问题由该服务的服务提供方提供支持。4.5接入技术规范4.5.1业务应用系统在调用服务接口时，应先进行身份鉴权，接口鉴权规范见附录B。4.5.2贵州省电子政务网平台已提供的“基础通用服务”类别的接口描述与技术规范见附录C。4.5.3贵州省电子政务网平台已提供的“政务业务事项服务”类别的接口描述与技术规范见附录D。4.5.4接口返回代码规范与对照表见附录E。4.5.5服务提供方在发布其它服务时的设计规范见附录F。5运维管理要求5.1业主单位管理要求5.1.1业主单位负责本单位所选取的业务应用系统的服务提供方的资质与能力审核，并为该业务应用系统或服务接入贵州省电子政务网应用平台进行审批并承担相应管理责任。5.1.2业主单位负责协调所选取的业务应用系统的服务提供方与平台运营方的对接工作。5.1.3业主单位应为本单位接入的业务应用系统制定相应的运维策略与安全策略，并确保正常执行。5.2服务提供方管理要求5.2.1服务提供方应为业务应用系统指定负责人，负责与平台运营方进行对接，并承担管理责任。5.2.2服务提供方应按规范提供业务应用系统或服务，并保障其正常稳定的运行于贵州省电子政务网应用平台之上。5.2.3服务提供方负责提供接入的业务应用系统及服务的技术支持和运维服务。4\nDB52/T1261—20185.2.4服务提供方应为接入的每一个业务应用系统或服务均提供测试报告，配合平台运营方的要求做联合调试工作，并确保其稳定性。5.2.5负责自己管理的业务应用系统或服务的缺陷修正及更新发布等工作。5.3服务使用方管理要求5.3.1按照贵州省电子政务网开放平台相关要求规范使用业务应用系统及服务。5.3.2在使用服务过程中如发现缺陷或需要改进的地方，应主动与平台运营方进行沟通。5.4平台运营方管理要求5.4.1负责贵州省电子政务网应用平台业务应用系统及服务接入的日常管理与技术支持。5.4.2负责平台基础通用服务和政务业务事项服务技术接口的维护更新与缺陷修正。5.5应急处置5.5.1业务应用系统或服务发生严重故障时，如影响到贵州省电子政务网应用平台或其它业务应用系统的正常运行时，平台运营方有权要求暂停该系统和服务，直到整改正常方可申请恢复。5.5.2业主单位和服务提供方应为接入的业务应用系统制定应急处置与故障处理办法，并严格执行。5\nDB52/T1261—2018AA附录A（规范性附录）接入管理流程相关信息表A.1业务系统注册基本信息表表A.1业务系统注册基本信息表厂商名称：厂商系统标识：接入业务系统名称：业务系统负责人：开通账号：登录密码：联系电话：联系邮箱：钉钉号：QQ号码：业主单位：业主单位联络人：联系电话：联系邮箱：服务厂商负责人签名：业主单位联系人签名：服务厂商用章：业主单位用章：业务系统将覆盖使用的单位范围：A.2服务使用申请基本信息表表A.2服务使用申请基本信息表厂商名称：厂商系统标识：要发起服务调用的业务系统：业务系统负责人：联系电话：联系邮箱：钉钉号：QQ号码：申请使用服务名称：申请使用原因：服务厂商负责人签名：业主单位联系人签名：服务厂商用章：业主单位用章：其它说明：6\nDB52/T1261—2018A.3服务发布申请基本信息表表A.3服务发布申请基本信息表厂商名称：厂商系统标识：已接入业务系统：业务系统负责人：联系电话：联系邮箱：钉钉号：QQ号码：申请发布的服务类别和名称：申请提供原因：服务厂商负责人签名：业主单位联系人签名：服务厂商用章：业主单位用章：服务覆盖使用的单位范围：A.4服务接口内容信息表表A.4服务接口内容信息表服务类别：服务接口名称：服务接口URL：接口方式：提供厂商：所属业务系统：是否收费：调用说明：使用协议：数据标准说明：测试dome样例：在线测试结果：A.5业务应用系统使用申请基本信息表表A.5业务应用系统使用申请基本信息表要申请使用的业务系统名称：申请单位名称：联系人：联系电话：联系邮箱：想覆盖使用的单位范围：其它说明：7\nDB52/T1261—2018BB附录B（规范性附录）接口鉴权规范B.1接口签名使用规范B.1.1待签名的字符串在请求参数列表中，除去sign签名和token令牌参数外，其他需要使用到的参数都是需要签名的参数，相关要求如下：a)对于参数排序要求是按a到z的顺序排序；b)参数统一使用小写字母方式；c)若参数存在多层结构，只取第一层进行签名；d)若参数没有值，无需包含到签名数据列表中；e)根据HTTP协议要求,传递参数的值中如果存在特殊字符(如:&、@等),那么该值需要做URLEncoding；f)待签名数据应该是原生值而不是encoding之后的值。注：调用某接口需要对请求参数email进行数字签名,那么待签名数据应该是email=test@qq.com,而不是email=test%40qq.com。B.1.2待签名字符串案例待签名字符串格式采用URI中QUERY参数串的方式进行组合，示例如下。示例：string[]parameters={“service=create_direct_pay_by_user”,“partner=2088101568338364”,“return_url=http://www.test.com/alipay/return_url.asp”,“subject=订单业务”,“payment_type=1”,“seller_email=test@qq.com”}注：如上的参数值进行自定义排序完成之后,再把所有数组值以“&”字符连接起来的字符串便是待签名字符串。partner=2088101568338364&payment_type=1&return_url=http://www.test.com/alipay/return_url.asp&seller_email=test@alipay.com&service=create_direct_pay_by_user&subject=订单业务。B.1.3进行签名B.1.3.1在签名时,需要私钥参与签名。私钥是以事先分配给不同接入账号的英文字母和数字组成的32位字符串。B.1.3.2当拿到请求时的待签名字符串后,需要把私钥直接拼接到待签名字符串的后面,形成新的字符串,利用SM3加密函数对这个新的字符串进行签名运算,从而得到签名结果字符串(该字符串赋值于参数sign)，并将签名结果字符串全部字母转换为小写字母。8\nDB52/T1261—2018B.2令牌使用规范使用基于Token的身份验证方法，大概的流程是这样的：a)客户端使用用户名跟密码请求登录；b)服务端收到请求，去验证用户名与密码；c)验证成功后，服务端会根据规则（|+本地时间+|+用户名+|+授权密码的SM3加密串）签发一个Token，再把这个Token发送给客户端；d)客户端收到Token以后可以把它存储起来，比如放在Cookie里；e)客户端每次向服务端请求资源的时候需要带着服务端签发的Token，服务端收到请求，然后去验证客户端请求里面带着的Token，如果验证成功，就向客户端返回请求的数据。B.3IP鉴权机制厂商在政务开放平台注册成功后，在调用接口前，都需要提供来访的应用IP地址，用于在服务调用前进行IP鉴权，鉴权成功后，服务接口才会响应请求，对于使用负载均衡或无法提供固定应用IP的应用，可以提交申请，告知开放平台对特定应用取消IP鉴权。B.4登录安全规范B.4.1登录认证时所需要的参数说明见表B.1。表B.1参数表字段名称类型说明clientLoginUrl字符串客户端自定义登录页面URL地址verifyUrl字符串服务端验证地址URL，验证登录票据是否合法返回登录信息字符串，多个字段以“，”分割。所有字段returnFields字符串名全部小写backUrl字符串登录成功后的返回页面排除过滤路径的资源，主要用于不需要进行认证就可以excludeStrings字符串资源的访问，支持目录和指定后缀的模糊配置系统推出后的通知接收URL，后台认证的多个系统中的loginOutUrl字符串任一系统推出后，系统会往成功登陆的其它系统发送消息，以实现单点退出功能。签名Key，用户服务端和客户端交互的签名加密传，每ENCRYPT_KEY字符串（16位）个系统分配唯一一个Key，为了安全不能外传。systemid字符串单点登录平台给每个客户端分配的唯一ID9\nDB52/T1261—2018B.4.2参数加密说明登录会对关键参数采用SM4加密，先加密得到二进制串，然后将二进制传转换为16进制字符串进行传递，传递到服务端后系统根据系统ID获取对应秘钥，然后进行解密后再进行认证登录，加密的字段包括：systemid，loginOutUrl，backUrl，returnFields，uid，pwd。B.4.3参数签名参见本标准附录B.1接口签名使用规范，签名字符串用的是加密后的字符串。以Java语言举例如下。示例：remoteLogin(Stringsystemid,Stringuid,Stringpwd,HttpServletRequestrequest,HttpServletResponseresponse)。参数说明见表B.2。表B.2参数表参数名称类型说明systemid字符串系统ID，平台给接入的业务系统分配的唯一标识uid字符串客户端输入的登录编号客户端输入的密码，密码为明文，系统客户端SDK中会先对密pwd字符串码进行加密后才进行传递。request对象Java的http请求对象response对象Java的http响应对象10\nDB52/T1261—2018CC附录C（规范性附录）基础通用服务接口设计C.1组织机构与人员服务设计C.1.1查看机构人员数据变动C.1.1.1服务描述机构人员微服务主要用于提供比如：获取机构信息，人员信息，机构人员分组信息，最近联系人，常用联系人以及选人窗口等服务给第三方应用系统调用。C.1.1.2服务地址请求方式：GET，请求地址：/api/gov/org/getOrgDataChangeInfo?sign=&token=。C.1.1.3请求参数说明表C.1参数表参数名参数类型必须说明signString是请求参数签名tokenString是调用token凭证userString是认证用户名，每个业务系统接入都会分配一个独立的认证用户名，不能为空pwdString是认证密码appsysidString否应用系统ID，可为空，如果为空则取视图表设置的业务系统数据，如果视图表中业务系统是也空，则所有数据accountlastchangedatetimeString是获取单位数据开始时间，主要是用取单位从这个时间起到当前为止，有变动的数据deptlastchangedatetime是获取部门数据开始时间，主要是用取部门从这个时间起到当前为止，有变动的数据userlastchangedatetime是获取人员数据开始时间，主要是用取人员从这个时间起到当前为止，有变动的数据indentitylastchangedateti是获取身份数据开始时间，me主要是用取身份从这个时间起到当前为止，有变动的数据datatypeString是获取数据类型，0取所有更新数据1只取单位更新数据2只取部门更新数据3只取人员更新数据4只取人员身份更新数据orgidString否单位编码ID，可为空，主要用来记录日志表deptidString否部门编码ID，可为空，主要用来记录日志表useridString是用户ID，主要用记录是哪个用户发过来的请求，主要用来记录日志表viewIdString是视图ID，要获取数据的视图ID，不能为空11\nDB52/T1261—2018C.1.1.4响应数据解析说明返回数据为XML格式，需要自行解析使用。示例：获取数据成功110442017-11-2914:50:01111578772017-11-1016:09:285792212292017-11-2823:24:2522132962017-10-1614:39:143注1：changeAccount：是单位变动信息，countrows为获取单位数据总记录数，loopcount为提示客户端业务系统将要循环向平台取单位实际数据的次数，lastdatetime是指单位数据更新最后时间，返回给客户端供下次调用当参数传递；12\nDB52/T1261—2018注2：changeDepartment：是部门变动信息，countrows为获取部门数据总记录数，loopcount为提示客户端业务系统将要循环向平台取部门实际数据的次数，lastdatetime是指部门数据更新最后时间，返回给客户端业务系统供下一次同步部门数据时调用；注3：changeUser：是人员变动信息，countrows为获取人员数据总记录数，loopcount为提示客户端业务系统将要循环向平台取人员实际数据的次数，lastdatetime是指人员数据更新最后时间，返回给客户端业务系统供下一次同步人员数据时调用；注4：changeUserIdentity：是身份（兼职、挂职、借调）变动信息，countrows为获取身份（兼职、挂职、借调）数据总记录数，loopcount为提示客户端业务系统将要循环向平台取身份（兼职、挂职、借调）实际数据的次数，lastdatetime是指身份（兼职、挂职、借调）数据更新最后时间，返回给客户端业务系统供下一次同步身份（兼职、挂职、借调）数据时调用。C.1.2服务动作C.1.2.1人员批量同步C.1.2.1.1服务描述提供给第三方开发商，用于批量获取人员数据，批量获取的数据支持分页获取，每页返回最大行数不能超过100条，系统会默认返回页码数，记录总行数、以及相关页的数据明细。C.1.2.1.2服务地址请求方式：GET，请求地址：/api/gov/org/getUserData?sign=&token=。C.1.2.1.3请求参数说明表C.2参数表参数名参数类型必须说明signString是请求参数签名tokenString是调用token凭证认证用户名，每个业务系统接入都会分配一个独立userString是的认证用户名。不能为空。pwdString是分配的用户密码，密码传递SM3加密后的字符串pageIndexInt否查询数据页码，不传默认获取第一页的数据pagesizeInt否每页返回记录数，不传默认100条每页13\nDB52/T1261—2018C.1.2.1.4返回数据返回数据是一个XML格式的字符串，需要自行解析，示例格式如下。示例：0记录总数总页数每页记录数获取成功….注：字段列表，可以根据原数据配置进行返回。14\nDB52/T1261—2018名称编码数据类型长度精度人员IDUSER_IDbigint用户KEYIDKEY_IDvarchar(32)32人员姓名USER_NAMEvarchar(32)32人员编号USER_CODEvarchar(32)32身份证号IDENTITY_CODEvarchar(18)18登录账号LOGIN_NOvarchar(32)32登录别名NICK_NAMEvarchar(32)32手机1MAIN_MOBILEvarchar(11)11手机2SUB_MOBILEvarchar(11)11密码MD5PWD_MD5varchar(32)32密码SHAPWD_SHAvarchar(128)128国产密码SM3PWD_GCvarchar(128)128状态STATUS_CODEvarchar(3)3性别SEX_FLAGint出生日期BIRTHDAYdate照片URLPHOTO_URLvarchar(200)200民族IDNATION_IDvarchar(3)3是否为单位管理员ORG_ADMIN_FLAGint(1)1应用系统ID串SYSAPPtext人员类型USER_TYPEvarchar(30)30党派PARTY_TYPEvarchar(30)30职称PERSON_TITLEvarchar(30)30学历DEGREE_TYPEvarchar(30)30个人简介PERSON_DESCtext是否政协委员COMMITTEE_FLAGvarchar(3)3是否人大代表DEPUTY_FLAGvarchar(3)3是否行政负责人HEADER_FLAGvarchar(3)3是否本单位领导LEADER_FLAGvarchar(3)3对应新Ｇ６idOTHER_IDvarchar(38)38启用标记ENABLE_FLAGint删除标记DELETE_FLAGint创建人IDCREATE_USER_IDbigint创建时间CREATE_TIMEdatetime最后修改人IDMODIFY_USER_IDbigint最后修改时间MODIFY_TIMEdatetime15\nDB52/T1261—2018C.1.3机构批量同步C.1.3.1服务描述提供给第三方开发商，用于批量获取机构数据，批量获取的数据支持分页获取，每页返回最大行数不能超过2000条，系统会默认返回页码数，记录总行数、以及相关页的数据明细。C.1.3.2服务地址请求方式：GET，请求地址：/api/gov/org/getOrgData?sign=&token=。C.1.3.3请求参数说明表C.3参数表参数名参数类型必须说明signString是请求参数签名tokenString是调用token凭证认证用户名，每个业务系统接入都会分配一个独立的认证用户名。不能为userString是空。pwdString是分配的用户密码，密码传递SM3加密后的字符串pageIndexInt否查询数据页码，不传默认获取第一页的数据pagesizeInt否每页返回记录数，不传默认100条每页16\nDB52/T1261—2018C.1.3.4返回数据返回数据是XML格式的字符串，需要自行解析，示例格式如下。示例：0记录总数总页数每页记录数获取成功所属体系1，政府2，人大，3政协，4党委….注：具体返回数据，根据管理后台元数据配置生成。17\nDB52/T1261—2018名称编码数据类型长度精度机构IDDEPARTMENT_IDbigint机构编号DEPARTMENT_CODEvarchar(50)50机构名称DEPARTMENT_NAMEvarchar(100)100机构简称SHORT_NAMEvarchar(50)50其它名称OTHER_NAMEvarchar(50)50上级机构IDPARENT_IDbigint所属单位IDORGAN_IDbigint是否单位ORGAN_FLAGint机构类型FOR_TYPEvarchar(3)3机构分类FOR_CLASSbigint所属行业FOR_INDUSTRYvarchar(6)6所属区域FOR_AREAvarchar(12)12所属城市FOR_CITYvarchar(12)12所属区县FOR_COUNTYvarchar(12)12所属乡镇FOR_TOWNvarchar(12)12所属归口FOR_GKvarchar(3)3节点属性FOR_NODE_TYPEbigint(30)30单位管理员ORGAN_ADMINvarchar(20)20单位地址ORGAN_ADDRvarchar(200)200邮编ZIP_CODEvarchar(6)6电话PHONEvarchar(30)30传真FAX_CODEvarchar(30)30状态STATUS_CODEvarchar(3)3排序权重PRIORITYint机构描述ORGAN_DESCvarchar(200)200职责描述ORGAN_DUTYvarchar(500)500启用标记ENABLE_FLAGint删除标记DELETE_FLAGint创建人IDCREATE_USER_IDbigint创建时间CREATE_TIMEdatetime最后修改人IDMODIFY_USER_IDbigint最后修改时间MODIFY_TIMEdatetime机构KeyKEY_IDvarchar(32)32C.1.4机构人员选择C.1.4.1服务描述提供给第三方开发商，选择人员和机构的界面，首先要通过系统验证，系统会先生成随机码，随机码只能使用一次，使用后自动作废。C.1.4.2服务地址18\nDB52/T1261—2018请求方式：GET，请求地址：/api/gov/org/getSelectUser?sign=&token=。C.1.4.3请求参数说明表C.4参数表参数名参数类型必须说明signString是请求参数签名tokenString是调用token凭证认证用户名，每个业务系统接入都会分配一个userString是独立的认证用户名。不能为空。分配的用户密码，密码传递SM3加密后的字符pwdString是串返回界面类型：1、返回机构人员选择界面selecttypeString否2、返回机构选择界面3、返回机构岗位人员界面注：如果传入参数为空默认为1C.1.4.4返回数据返回数据是XML格式的字符串，需要自行解析处理，示例格式如下。示例：0记录总数获取成功C.2统一认证服务设计C.2.1远程系统登录验证C.2.1.1服务描述提供给第三方开发商，提供给第三方调用，进行用户密码认证，认证需要调用客户端的API方法进行验证，系统会对验证过程中的用户名密码等相关参数进行签名和命名重写，保证传输过程中的数据安全，安全规则遵行本标准附录B.4登录安全规范执行。统一认证支持自定义登录页面，指的是业务系统采用自己的登录界面，与后端认证服务器进行通信进行认证和创建票据。自定义登录页面的认证过程和统一认证登录界面的认证过程一样，业务系统需要调用SDK包中的客户端认证方法即可。19\nDB52/T1261—2018C.2.1.2服务地址请求方式：GET，请求地址：/api/gov/org/remoteLogin?sign=&token=。C.2.1.3请求参数说明表C.5参数表参数名参数类型必须说明signString是请求参数签名tokenString是调用token凭证userString是认证用户名，每个业务系统接入都会分配一个独立的认证用户名。不能为空。pwdString是分配的用户密码，密码传递Md5或SHA或国密SM3加密后的字符串systemidString是登录的系统C.2.1.4返回数据返回数据是XML格式的字符串，需要自行解析处理，示例格式如下。示例：0获取成功返回字段列表登录票据C.3统一日志服务C.3.1日志信息推送C.3.1.1请求说明请求方式：POST，请求地址：/api/base/log/push?sign=&token=。C.3.1.2请求包结构体请求包结构体数据是XML格式的字符串，示例格式如下。示例：20\nDB52/T1261—2018collKey张三修改人5235436557655修改台帐修改台帐2017年8月3日个人台帐个人台帐2231成功default100.96.129.135235436557655张三85542432244部门16653544365435xx单位2017-08-2316:32:430frombatchId...21\nDB52/T1261—2018C.3.1.3请求参数说明表C.6参数表参数名参数类型是否必须说明signString是请求参数签名tokenString是调用token凭证collKeyString是特定键值，使用接口时分配authCodeString否预留字段，留空的字符串mainOString是操作主体对象mainOTypeString是操作主体对象类型operationIdString是操作类型idoperationString是操作类型描述beOperationOString是被操作对象beOperationOTypeString是被操作对象类型beOperationOIdString是被操作对象idoperationResultString是操作结果operationResultIdString是操作结果idsystemIdString是系统标识serverIpString是服务器ipstaffIdString是用户idstaffNameString是用户姓名deptIdString是所在部门iddeptNameString是所在部门名称orgIdString是所在单位idorgNameString是所在单位名称addTimeString是添加时间（操作时间）beOMhIdString否被操作门户idbeOMhNameString否被操作门户名称beOrgIdString否被操作单位idbeOrgNameString否被操作单位名称beOdeptIdString否被操作部门idbeOdeptNameString否被操作部门名称日志级别，操作级别，一般规则是安全操作（如访问，预览，浏览等）logLeaveString是为级别0，新增与修改为级别1，删除为级别2，批量删除为级别322\nDB52/T1261—2018表C.6参数表（续）参数名参数类型是否必须说明fromString否来自终端bemark1String否备注字段1bemark2String否备注字段2bemark3String否备注字段3bemark4String否备注字段4bemark5String否备注字段5batchIdString否预留C.3.1.4响应格式返回数据是XML格式的字符串，需要自行解析处理，示例格式如下。示例：true数据添加成功C.3.1.5响应格式说明参数名参数类型是否必须说明statusString是成功为ok,否则为errmessageString是状态信息,一般用来标识错误信息C.4统一消息提醒服务C.4.1消息提醒推送C.4.1.1请求说明请求方式：POST，请求地址：/api/base/message/push?sign=&token=。C.4.1.2请求包结构体请求体为一个XML文档,结构如下。示例：32543535346432543535346554464567523\nDB52/T1261—201854464567554567586876http://efdsafdsahttp://ret12张三2014-12-0100:00:002014-12-0100:00:00消息内容可不能带有HTML标签哦,最长不要超过250个字符...C.4.1.3请求参数说明参数名参数类型是否必须说明signString是请求参数签名tokenString是调用token凭证zip压缩文件notices根节点notice每个提醒为一个notice结点,可以一次推送几条提醒notice-user接收通知的用户ID,可同时推送多个用户notice-org接收通知的部门ID，可同时推送多个部门notice-department接收通知的单位ID，可同时推送多个单位content-url内容连接,可以省略,当用弹出窗口提醒时这个窗口内容action-url回执连接,可以省略,当不省略时,用户阅读这条消息提醒时会自动访问这个地址notice-mode提醒方式,1普通提醒,2强制提醒notice-type提醒方式,1冒泡提醒,2弹窗提醒publish-user发布人(统一的用户ID)publish-time发布时间,立即发布的可以省略,否则为定时发送机制(预留)过期时间,过期时间设置不能超过3个月,过期的提醒系统自动删除掉,如果不设置,系统默expire-time认为三个月message消息内容,不能带HTML标签,内容长度不能超过250个字符。24\nDB52/T1261—2018C.4.1.4响应格式返回数据是XML格式的字符串，需要自行解析处理，示例格式如下。示例：ok成功C.4.1.5响应格式说明参数名参数类型是否必须说明statusString是成功为ok,否则为errmessageString是状态信息,一般用来标识错误信息C.5统一参数服务C.5.1获取系统参数C.5.1.1请求说明请求方式：GET，请求地址：/api/base/param/getParam?sign=&token¶mkey=¶mtype=。C.5.1.2请求参数说明参数名参数类型是否必须说明signString是请求参数签名tokenString是调用token凭证paramkeyString是参数keyparamtypeString是参数类型C.5.1.3响应格式返回数据是JSON格式的字符串，需要自行解析处理。示例格式如下。示例：{"status":ok,"mesage":"成功","paramvalue":"参数值"}25\nDB52/T1261—2018C.5.1.4响应格式说明参数名参数类型是否必须说明statusString是成功为ok,否则为errmessageString是状态信息,一般用来标识错误信息paramvalueString是参数value值C.6统一待办服务C.6.1统一令牌服务C.6.1.1获取token令牌C.6.1.1.1请求说明请求方式：GET，请求地址：/api/base/token/getToken?sign=。C.6.1.1.2请求包结构体请求包结构体数据是XML格式的字符串，需要自行构建处理。示例格式如下。示例：2014-07-1012:23:32yjaabbccddeeff0011223344C.6.1.1.3请求参数说明参数名参数类型是否必须说明signString是请求参数签名client-timeString是必须是yyyy-mm-ddHH:ii:ss格式usernameString是授权的用户名|+本地时间+|+用户名+|+授权keyString是密码的SM3加密串,如:|2017-08-1012:23:32|yj|YjPasswordC.6.1.1.4响应格式返回数据是XML格式的字符串，需要自行解析处理。示例格式如下。示例：26\nDB52/T1261—2018ok4565aabbccddeeff0011223344授权成功C.6.1.1.5响应格式说明参数名参数类型是否必须说明statusString是成功为ok,否则为errmessageString是状态信息,一般用来标识错误信息tokenString是获得的授权码,这个授权码可以在10分钟内使用。27\nDB52/T1261—2018DD附录D（规范性附录）政务业务事项服务设计D.1台账信息服务设计D.1.1个人台账推送D.1.1.1请求说明请求方式：POST，请求地址：/api/gov/ledger/push?sign=&token=。D.1.1.2请求包结构体返回数据是JSON格式的字符串，需要自行解析处理，示例格式如下。示例：{"id":"tzid1001","title":"台账标题","content":"台账内容","noteTime":"2017-09-05","finishDesc":“完成办理”,"dealItemDesc":"办理事项描述","userId":"台账所属人","userName":"台账所属人姓名","crateUserId":"台账创建人","createUserName":"台账创建人姓名","createTime":"2017-08-1412:23:21","updateTime":"2017-08-1412:23:21","remark":“备注”,"isPush":1}28\nDB52/T1261—2018D.1.1.3请求参数说明参数名参数类型是否必须说明signString是请求参数签名tokenString是调用token凭证个人台账字段title内容的标题,不能带HTML标签,也不能省略content台账内容noteTime台账日期，台账属于哪天的finishDesc办理情况描述，完成办理，未完成，等简单描述dealItemDesc办理事项描述userId台账所属人userName台账所属人姓名crateUserId台账创建人createUserName台账创建人姓名createTime创建时间，必须是yyyy-mm-ddHH:ii:ss格式updateTime更新时间，必须是yyyy-mm-ddHH:ii:ss格式remark备注isPush是否推送到处室空间。1：推送，0：推送D.1.1.4响应格式返回数据是JSON格式的字符串，需要自行解析处理，示例格式如下。示例：{"status":“ok”,"mesage":"成功"}29\nDB52/T1261—2018D.1.1.5响应格式说明参数名参数类型是否必须说明statusString是成功为ok,否则为errmessageString是状态信息D.2通知公告服务设计D.2.1通知公告推送D.2.1.1请求说明请求方式：POST，请求地址：/api/gov/notice/push?sign=&token=。D.2.1.2请求包结构体D.2.1.2.1请求包内容及其附件采用zip压缩成一个压缩包提交到数据服务器,实现数据推送.只要按照预定格式压缩,一次可以推送多条信息。D.2.1.2.2压缩文件里必须拥有一个manifest.xml文件,这个文件用来描述推送信息要素。示例格式如下。示例：faefdsafadfdsaff01无2017-08-1412:23:212017-09-1412:23:21放在外部文件的文件格式目前仅支持文本文件30\nDB52/T1261—2018]]>2222222222234213314154464567554464567554567586876325435353464325435353465......D.2.1.3请求参数说明31\nDB52/T1261—2018参数名参数类型是否必须说明signString是请求参数签名tokenString是调用token凭证zip压缩文件notifications根节点notificationnotification表示一条通知公告,可以有多个notification标签,实现一次性推送多条信息.title内容的标题,不能带HTML标签,也不能省略guid信息唯一标识符,长度不超过16位的字母+数字组成的字符串,从同一个业务系统来的不同信息具有不同的标识,同一条信息必须一致,当多次推同一个标识的信息过来后,后面的会替换掉前面的信息.notice-type提醒方式，0不提醒，1系统内提醒，2短信提醒，3系统+短信提醒，默认不提醒require-receipt是否需要回执，0不需要，1需要emergency-levelstart-time开始时间，必须是yyyy-mm-ddHH:ii:ss格式end-time结束时间，必须是yyyy-mm-ddHH:ii:ss格式reviewer审核人ID,没有为不需要审核，目前仅支持一个审核人feedback-remind-uid反馈提醒用户ID，如果没有则不提醒reciept-org接收单位，可以有多个reciept-department接收部门，在只发给某单位下一些特有的部门时使用，可以有多个reciept-user接收人，只发给具体的人时使用，可以有多个content这是通知公告内容,可以带HTML标签，也可以放在单独的文件里,放在单独的文件时,如：1.file属性来标识文件路径,2.encoding来标识文件字符集,3.type来标识文件类型,放在外部文件的文件格式目前仅支持文本文件；html里的图片文件要按图片路径一起打包在zip文件中,比如:,...在zip包里的path/to/目录应该有个image.png文件,绝对路径如http://domain/path/image.jpg将不对这文件进行处理,图片路径前的"./","../","/"等将被忽略。attachment附件一般格式如下:各属性说明1.file文件路径,同content标签的file属性2.title附件标题,不能带HTML标签,在30字以下3.info附件描述,不能带HTML标签,在50字以下32\nDB52/T1261—2018D.2.1.4响应格式返回数据是XML格式的字符串，需要自行解析处理，示例格式如下。示例：ok成功....D.2.1.5响应格式说明参数名参数类型是否必须说明statusString是成功为ok,否则为errmessageString是状态信息,一般用来标识错误信息documentsString是只有status为ok时，有这个结点推送内容的详细处理结果。1.guid对应推送内容的guid,2.status为处理结果,一般处理结documentString是果有:已推送,已忽略,已更新和出错,当为出错时,属性message表示简单的出错信息33\nDB52/T1261—2018D.3文档转换服务设计D.3.1文档在线预览D.3.1.1请求说明请求方式：GET，请求地址：/api/gov/docTrans/preview?sign=&token=&docurl＝。D.3.1.2请求参数说明参数名参数类型是否必须说明signString是请求参数签名tokenString是调用token凭证docurlString是文档路径D.3.1.3响应格式返回数据是JSON格式的字符串，需要自行解析处理。示例格式如下。示例：{"status":“ok”,"mesage":"成功","previewurl":"http://......"}D.3.1.4响应格式说明参数名参数类型是否必须说明statusString是成功为ok,否则为errmessageString是状态信息,previewurlString是文档预览到url路径D.4门户推送服务设计D.4.1查询可推送栏目34\nDB52/T1261—2018D.4.1.1请求说明请求方式：GET，请求地址：/api/gov/portal/getcolumns?sign=&token=。D.4.1.2响应格式返回数据是XML格式的字符串，需要自行解析处理，示例格式如下。示例：ok成功....D.4.1.3响应格式说明参数名参数类型是否必须说明statusString是成功为ok,否则为errmessageString是状态信息,columnsString是栏目集合columnString是具体栏目source-idString是栏目源IDtitleString是栏目标题35\nDB52/T1261—2018D.4.2推送数据到栏目D.4.2.1请求说明请求方式：POST，请求地址：/api/gov/portal/push?sign=&token=&sourceid=12&duplicate=ignore。D.4.2.2请求包结构体提交过来的是一个压缩文件，压缩文件里必须拥有一个manifest.xml文件,这个文件用来描述推送信息要素，一个简单的manifest.xml文件示例格式如下。示例：faefdsafadfdsaff1大分类小分类普通http://test.gz.cegn.cn/test/test.html2014-06-1412:23:21放在外部文件的文件格式目前仅支持文本文件]]>......36\nDB52/T1261—2018D.4.2.3请求参数说明参数名参数类型是否必须说明signString是请求参数签名tokenString是调用token凭证sourceidString是栏目数据源IDduplicateString否参数duplicate为重复(唯一ID)时的解决方案,可用:ignore(忽略,默认值),update(更新)zip压缩文件documents这是推送信息文档的根结点document表示一条内容信息,可以有多个document标签,实现一次性推送多条信息。title内容的标题,不能带HTML标签,也不能省略,guid信息唯一标识符,长度不超过16位的字母+数字组成的字符串,从同一个业务系统来的不同信息具有不同的标识,同一条信息必须一致,当多次推同一个标识的信息过来后,后面的会替换掉前面的信息。scope可见权限,1全省可见,2本单位可见type来源信息分类sub-type来源信息小分类important-level重要级别,一般分为:普通,急件,特急,特提.可以省略,省略时按普通级别算link-url链接地址,一般用来直接到业务系统进行访问的地址,通常情况下应该是不带权限限制的地址datetime时间,一般为发布时间,必须是yyyy-mm-ddHH:ii:ss格式content这是通知公告内容,可以带HTML标签，也可以放在单独的文件里,放在单独的文件时,如：1.file属性来标识文件路径,文件必须放在压缩包里,文件可以是word文档,wps文档和txt文档。2.encoding来标识文件字符集,3.type来标识文件类型,放在外部文件的文件格式目前仅支持文本文件；html里的图片文件要按图片路径一起打包在zip文件中,比如:,...在zip包里的path/to/目录应该有个image.png文件,绝对路径如http://domain/path/image.jpg将不对这文件进行处理,图片路径前的"./","../","/"等将被忽略。attachment附件一般格式如下:各属性说明1.file文件路径,同content标签的file属性。2.title附件标题,不能带HTML标签,在30字以下3.info附件描述,不能带HTML标签,在50字以下D.4.2.4响应格式返回数据是XML格式的字符串，需要自行解析处理，示例格式如下。示例：37\nDB52/T1261—2018ok成功....D.4.2.5响应格式说明参数名参数类型是否必须说明statusString是成功为ok,否则为errmessageString是状态信息,一般用来标识错误信息documentsString是只有status为ok时，有这个结点推送内容的详细处理结果。1.guid对应推送内容的guid,documentString是2.status为处理结果,一般处理结果有:已推送,已忽略,已更新和出错,当为出错时,属性message表示简单的出错信息D.4.3查看已推送数据状态D.4.3.1请求说明请求方式：POST，请求地址：/api/gov/portal/pushstatus?sign=&token=。D.4.3.2请求包结构体请求数据是XML格式的字符串，需要自行解析处理，示例格式如下。示例：1238\nDB52/T1261—2018....D.4.3.3请求参数说明参数名参数类型是否必须说明signString是请求参数签名tokenString是调用token凭证待查找的栏目数据源id,不能省略,每source-idString是个请求只能查询一个数据源的数据要查找推送的内容,可以同时查找多个documentString是内容,每个内容要带guid属性,也就是推送时的唯一ID标识D.4.3.4响应格式返回数据是XML格式的字符串，需要自行解析处理，示例格式如下。示例：ok成功afdsaffdsa2014-07-1212:21:22已推送afdsaffdsa2014-07-1212:21:22已采用39\nDB52/T1261—2018D.4.3.5响应格式说明参数名参数类型是否必须说明statusString是成功为ok,否则为errmessageString是状态信息,一般用来标识错误信息推送内容的查询结果。1.guid对应推送内容的guid,2.title推送消息标题documentString是3.time推数据的时间4.status为处理结果,一般处理结果有:已推送,已采用等40\nDB52/T1261—2018EE附录E（规范性附录）返回代码对照表E.1在使用服务接口的过程中，平台对不同的返回代码进行分类，供服务提供方和服务使用方在调测及使用过程中参考。表E.1返回代码对照表响应代码状态描述问题排查策略0正常服务调用正常，有结果返回-1服务端异常服务器端平台出错，抛出异常。1001签名验证失败传递的签名不正确（未按正确的算法生成）或签名过期1002Key不正确或过期对照开发指南配置功能，检查给定的Key添加是否正确。1003没有权限使用接口开发者没有权限使用相应的服务接口。请检查您的请求参数的值有没有按照规范要求填写。1004请求参数非法例如，某参数值域范围为[1,3],开发者传了’4’1005缺少必填参数请检查您的请求参数是否有漏写的情况存在41\nDB52/T1261—2018FF附录F（规范性附录）服务设计规范F.1由于各个业务系统和平台之间存在差异性，为确保贵州省电子政务网开放平台的稳定高效，在各业务应用系统设计服务接口时，应遵行下列要求条款：a)接口协议统一：1)所有服务的接口均基于HTTP协议的WebService技术以及Restful风格的原子服务能力接口；2)服务提供方和服务使用方必须同时使用同一种类型的技术来进行开发和调用，调用的服务通过HTTPURL中特定属性进行标识。b)服务定义唯一性：一个服务应该只实现一个业务功能，业务功能的区别通过服务编码来区分，不应通过定义不同的业务数据在同一个服务编码下实现不同的业务功能。c)数据格式统一：所有接入到电子政务开放平台的服务的接口数据包含公共框架层和业务框架层两部分，接口数据采用XML格式或者JSON格式，大数据量的接口数据可以辅以文本文件格式，文本内容也应采用XML格式或者JSON格式。d)调用控制：1)鉴权原则：对于注册发布到电子政务开放平台的服务，服务消费者只有经平台鉴权通过并授予访问权限后才能调用服务；2)频度控制原则：电子政务开放平台对服务调用的频度做相应的检查控制，如果在单位时间内的调用次数超过上限值将返回给服务消费者异常信息，通知已超过调用频度上限；3)流量控制原则：电子政务开放平台对服务调用的流量做相应的检查控制，如果在单位时间内的总流量超过上限值将返回给服务消费者异常信息，通知已超过流量上限；4)超时控制原则：电子政务开放平台对服务调用的单次访问时间做相应的检查控制，如果在一定时间内没有完成服务请求/响应过程，将返回给服务消费者异常信息，通知已经访问超时。e)规则校验：服务提供方应对请求报文格式和关键信息进行合规性和业务校验，防止非法访问和入侵。f)服务无状态：服务应是无状态的，两次请求之间无须状态和会话的保持，并可以采用轮询的方式在负载均衡器上进行注册。g)服务组合：服务按照服务粒度设计成原子服务和组合服务。原子服务为最细粒度的服务，组合服务由原子服务组合而成。为有效提高组合服务的效率，跨系统的组合服务由开放平台调用不同的原子服务实现组合，系统内的组合服务由服务提供方在应用内部进行组合。42\nDB52/T1261—2018h)持久化：服务使用方在使用服务的过程中，由开放平台进行整个过程的日志记录，并对调用的详细信息进行持久化，便于对账和稽核。建议服务调用方和提供方对调用的关键信息（如流水号，源地址等）进行持久化。_________________________________43\nDB52/T1261-2018