《警务大数据权限管控平台-服务对接指导文档.docx》由会员分享,可在线阅读,更多相关《警务大数据权限管控平台-服务对接指导文档.docx(19页珍藏版)》请在课桌文档上搜索。
1、吉大正元警务大数据权限管控平台服务对接指导文档V5.01 概述32 接口调用32.1 令牌同步接口32.2 应用级鉴权接口32.3 功能级鉴权接口42.4 数据级鉴权接口52.5 接口数据级鉴权接口62.6 应用权限变更通知62.7 功能权限变更通知72.8 接口服务级鉴权接口(返回标识符)72.9 接口服务级鉴权接口(返回地址)82.10 接口权限变更通知82.11 平台应用级鉴权接口83 附录93.1 用户令牌93.2 应用令牌103.3 令牌同步参数样例103.3.1 请求参数103.3.2 响应参数103.4 应用级鉴权参数样例113.4.1 请求参数113.4.2 响应参数Il3.5
2、 功能级鉴权参数样例113.5.1 请求参数113.5.2 响应参数123.6 数据级鉴权参数样例123.6.1 请求参数133.6.2 响应参数133.7 接口级鉴权参数样例133.7.1 请求参数133.7.2 响应参数143.8 应用权限变更通知参数样例153.8.1 请求参数153.8.2 响应参数163.9 功能权限变更通知参数样例163.9.1 请求参数163.9.2 响应参数163.10 接口服务级鉴权参数样例(返回标识符)173.10.1 请求参数173.10.2 响应参数173.11 接口服务级鉴权参数样例(返回地址)173.11.1 请求参数173.11.2 响应参数.18
3、3.12 接口权限变更通知参数样例183.12.1 请求参数183.12.2 啕应参数793.13 平台应用级鉴权参数样例193.13.1 请求参数193.13.2 响应参数201概述警务大数据权限管控平台(以下简称“权限管控平台”)维护业务系统权限资源及角色,完成授权动作并对业务系统提供鉴权服务,本文档对业务系统对接服务涉及到的接口进行说明。2接口调用2.1 令牌同步接口服务描述用户登录认证中心,认证中心为用户发放用户令牌,认证中心将用户令牌下发至各中心;用户登录业务应用时认证中心为用户发放应用令牌,并将应用令牌下至各中心。服务地址htgiD:IDOrtPDAtokentokenActicn
4、tokenSyncNotification.do服务方法POST请求参数说明名称参数标识父参数标识说明类型样例令牌信息认证中心下发的用户基本信息json附录3.3.1响应的参数说明令牌同步状态statusString附录332令牌同步结果描述messageString附录3.3.22.2 应用级鉴权接口服务描述用户登录认证平台后,认证平台携带用户令牌调用鉴权系统应用级鉴权接口完成应用级鉴权。鉴权系统将根据用户令牌将用户所具有权限的应用系统返回。服务地址http:/ip:port/PDA_Auth/platform/app.do服务方法POST请求参数说明名称参数标识父参数标识说明类型样例用户令
5、牌认证中心下发的用户基本信息json附录3.4.1响应的参数说明鉴权结果标识code鉴权结果码001:成功:008:鉴权用户无效;009:用户令牌无效String附录3.4.2鉴权结果数据resultdata用户具有权限的以逗号(,)分隔的应用标识,如果有平台code则返回平台code,如果没有平台COde则返回自身codeoString附录3.4.22.3 功能级鉴权接口(返回标识符)服务描述用户登录业务应用,业务应用携带应用令牌和任务信息调用鉴权系统功能级鉴权接口完成功能级鉴权。鉴权系统将根据应用令牌中用户信息及应用信息将用户在此应用下具有权限的功能资源标识符返回。服务地址hup:/ipl
6、:port/PDA_Auth/user/funs.do服务方法POST请求参数说明名称标识父参数标识说明类型样例应用令牌认证中心下发的应用基本信息json附录3.5.1任务信息(类型)附录3.5.1响应的参数说明鉴权结果标识code鉴权结果码001:成功;002:应用接入凭证无法匹配;003:应用代码无效;007:鉴权用户在此应用下无功能资源权限:008:鉴权用户无效;009:用户信息无效String附录3.5.2鉴权结果数据resultdata用户具有权限的以逗号(,)分隔的功能标识String附录3.5.22.4 功能级鉴权接口(返回地址)服务描述用户登录业务应用,业务应用携带应用令牌和任
7、务信息调用鉴权系统功能级鉴权接口完成功能级鉴权。鉴权系统将根据应用令牌中用户信息及应用信息将用户在此应用下具有权限的功能资源地址返回。服务地址http:Hd:IDortl/PDAAUthuse7funsUrLdo服务方法POST请求参数说明名称标识父参数标识说明类型样例应用令牌认证中心下发的应用基本信息json附录3.6.1任务信息(类型)附录3.6.1响应的参数说明鉴权结果标识code鉴权结果码001:成功;002:应用接入凭证无法匹配:003:应用代码无效;007:鉴权用户在此应用下无功能资源权限:008:鉴权用户无效;009:用户信息无效String附录3.6.2鉴权结果数据result
8、data用户具有权限的以逗号(,)分隔的功能地址String附录3.6.22.5 数据级鉴权接口服务描述用户登录业务应用,业务应用携带应用令牌及数据资源标识符或者资源英文名称调用鉴权系统数据级鉴权接口完成数据级鉴权。鉴权系统将根据用户具有的数据资源权限及此次请求所携带的任务、应用、机构的数据资源权限取交集进行返回。服务地址http:ip:port/PDAAUthv2dataAuth服务方法POST请求参数说明名称标识说明类型是否必填应用令牌appToken参见认证平台应用令牌信息数据项json是任务类型taskClass任务类型String是数据资源标识符resourceIds数据资源标识符S
9、tring否(与英文名称至少一个必填)数据资源英文名称resourceEnNames数据资源英文名称String否(与标识符至少一个必填)响应的参数说明结果标识codeOOl成功500其他错误String是结果标识信息message结果标识中文描述信息String是结果信息result数据项英文名称String是2.6 接口数据级鉴权接口服务描述用户登录业务应用,业务应用完成用户请求需要调用具体的业务服务,业务服务携带应用令牌及请求XmI调用鉴权系统服务级鉴权接口完成服务级鉴权。鉴权系统将判断应用是否有访问此服务的权限,若有权限则会根据用户所具有的数据资源权限与携带的任务、应用所具有的数据资源
10、权限取交集返回。服务地址http:/ip:portPDAAuthservicecheckAuth.do服务方法POST请求参数说明名称标识说明类型样例鉴权XmlXmlxml附录3.7.1响应的参数说明鉴权结果数据result经过权限过滤后的xmlString附录3.7.22.7 应用权限变更通知服务描述当人员的应用资源权限发生变化时,权限管理中心将向认证中心发送应用权限变化通知。请求地址由接收方定义服务方法POST请求参数说明名称标识说明类型样例用户令牌认证中心下发的用户基本信息Json附录3.8.1响应的参数说明状态码code“001”表示成功其它值表示失败String附录3.8.2详细信息
11、msg详细信息,建议在失败时填写详细的失败原因。String2.8 功能权限变更通知服务描述当人员的功能资源权限发生变化时,权限管理中心将向应用平台发送功能权限变化通知。请求地址由接收方定义服务方法POST请求参数说明名称标识说明类型样例应用令牌认证中心下发的应用基本信息Json附录3.9.1响应的参数说明状态码code“001”表示成功其它值表示失败String附录3.9.2详细信息msg详细信息,建议在失败时填写详细的失败原因。String2.9 接口服务级鉴权接口(返回标识符)服务描述用户登录业务应用,业务应用携带应用令牌调用鉴权系统接口服务级鉴权接口,触发后置服务调用由可信APl代理,
12、从鉴权服务获取人或应用可访问的接口服务标识符列表。服务地址http:ip:portPDA_Auth/ServiceZcheckInterFaceCode.do服务方法POST请求参数说明名称标识父参数标识说明类型样例应用令牌appToken参见认证平台应用令牌信息数据项json附录3.10.1响应的参数说明鉴权结果标识code鉴权结果码001:成功;008:鉴权用户无效;009:应用令牌无效String附录3.10.2鉴权结果数据resultdata以逗号(,)分割服务接口资源标识String附录3.10.22.10 接口服务级鉴权接口(返回地址)服务描述用户登录业务应用,业务应用携带应用令牌
13、调用鉴权系统接口服务级鉴权接口,触发后置服务调用由可信APl代理,从鉴权服务获取人或应用可访问的接口服务地址列表。服务地址http:/ipl:portPDA_Auth/ServiceZcheckInterFaceUrl.do服务方法POST请求参数说明名称标识父参数标识说明类型样例应用令牌appToken参见认证平台应用令牌信息数据项json附录3.11.1响应的参数说明鉴权结果标识code鉴权结果码001:成功;008:鉴权用户无效;009:应用令牌无效String附录3.11.2鉴权结果数据resultdata服务接口资源地址的集合String附录3.11.22.11 接口权限变更通知服务
14、描述当人员的接口资源权限发生变化时,权限管理中心将向可信API代理发送接口权限变化通知。请求地址由接收方定义服务方法POST请求参数说明名称标识说明类型样例应用令牌认证中心下发的应用基本信息Json附录3.12.1响应的参数说明状态码code“001”表示成功其它值表示失败String附录3.12.2详细信息msg详细信息,建议在失败时填写详细的失败原因。String附录3.12.22.12 平台应用级鉴权接口服务描述用户登录认证平台后,认证平台携带应用令牌调用鉴权系统平台应用级鉴权接口完成平台应用级鉴权。鉴权系统将根据应用令牌将用户所具有权限的应用系统返回。服务地址http:/ip:port
15、PDA_Auth/platform/platformApp.do服务方法POST请求参数说明名称参数标识父参数标识说明类型样例应用令牌认证中心下发的应用基本信息json附录3.13.1响应的参数说明鉴权结果标识code鉴权结果码001:成功;008:鉴权用户无效;009:用户令牌无效String附录3.13.2鉴权结果数据resultdata用户具有权限的以逗号(,)分隔的应用标识,根据平台CO加过滤结果,如果属于该平台下的应用则返回Code,如果不是平台下的应用则不返回。String附录3.13.2业务系统可根据自身鉴权所需选择适用鉴权接口进行鉴权操作,接收鉴权结果后您只需要根据自己的业务完
16、成业务控制即可。3附录3.1 用户令牌参数中文名称参数标识父参数标识参数类型格式类型是否必填说明用户令牌IDid字符串是用户令牌ID用户行为action字符串是令牌行为OnIineIoffiCelrenew,上线、下线、续期令牌类型type字符串是固定值USer组织机构代码orgCode字符串是环境env字符串是环境,pcImobilel设备IDmid字符串是设备挑战值challenge字符串是令牌创建时间CreateTime字符串是格式如下:2019-05-2310:43:23令牌到期时间expireAt字符串是格式如下:2019-05-2310:43:23人员姓名name字符串是人员OPE
17、NIDPid字符串是3.2 应用令牌参数中文名称参数标识父参数标识参数类型格式类型是否必填说明应用令牌IDid字符串是用户行为action字符串是令牌行为Onlineofficerenew,上线、下线、续期令牌类型type字符串是固定值app应用CoDEappCode字符串是应用CODE用户令牌userTokenJSON对象是令牌创建时间CreateTime字符串是格式如下:2019-05-2310:43:23令牌到期时间expireAt字符串是格式如下:2019-05-2310:43:233.3 令牌同步参数样例3.3.1请求参数9EVjloincXrA-0nlWQ6cUoyhadtc0vM
18、gYDBefTHKjRxwVvhLg3b58xBkkJBazJEt6RfDt8Sd8VRifMrEGXr4G67oQ5rVtcX_E87-FqgutCrXRrLFyfNksmF6JBS0o0K305YIL8RIzyp6Yvmfe9uNZc0Prg5HAEXfv-Tg3yCKTZIxg5ajt9FXd5hxgtcaqJsLCyaK,AaI7yrvcUyKCH6一Gn2cFYzst0umZT9jwxvQddTZdJEFu2x4dA13ce73f4WP9gp4KbGBcIidGVmbf5J5WGhfSWQDUOJZ町ja9xBkqJ9U0Lw4C7rxPb3R2rt90_PsqlhjlTDTsbes
19、BH8i0_dZYliKmopQbwYNRDjvSnNziCcLEdwLUdZvHlJ0rqSfcK09v3inNtrBxVF2KyLE8_V-t6yV4Eeq041oH_yMNjZZlY7mQuSnd_PsDgBhq7IPC2D3XpLLgCWi0tNntw-3c8w71ywo7DPxXlAFekhZmid0akDSlXHacoohbTcvt2WdIti3W6PMDkFy_M_bh0PslauDbHffis0ZWsk7tQ5zd27f72BPW37_QUw9JrTB3jqpAw9neo0WZ6F-djx4wJPW8yiN(mMWG5ClYv6sXk9MvljlHLcicsSZDjMZfZNq
20、KQq-OLt-0a5qXIqRDMuSz4MrlNxkJBldDbtWrVfrPzwwYwmTSIuQPK-lRlbr-ehC6NfewCN-GlTLLQhV-q82g8sZCZ_YLQEmVuW5UJLaZlgqmv7JdniMIklbjPTCVhaYkyv-sXFFjFQeitSS4VX_T31bHk7JxllHlR0wowv39cbuWyjGiPhAniL02RNhZf7XFr87DpqIq76Cs-2kjSfNTqnF9nb0A8t7KTPRb2FXHk5cPWcZkqYosPEIyLirSTadpSKQ7DSQYj3YxqEp30JYS0y59BlCCabXCE-83NVXLf64
21、WIrUHCICmLZvnLJSMfibZz8PGjIaMvULeaC9A.3.3.2响应参数StatUS:OOoo”,“message:成功3.4 应用级鉴权参数样例3.4.1 请求参数token”:“appToken” : *userToken*: *createTime *2019-05-23 10:38:23”,orgCode*: 3, name : 2 , mid : 5 , “challenge: *6*, action : online , pd : 7 ,id”: *e7e7a75e98bd89b7c80ce8517294e76d “ “ ” ” env : PC ,QWEWQ
22、ESD=SDSDWQESKJLSKXVUXNKJttSXBCMSDKQWHE4309SDASDKJNSJKJHKJHZXNCZMXNCBZ.用户令牌样例:“token”:*createTime*:*2019-05-2310:38:23”,orgCode:3,name:2,”HRLRmid:3,challenge:6,action:online,pid:7,id:e7e7a75e98bd89b7c80ce8517294e76d,env:pc”,type:user,“expireAt”:*2019-05-2310:43:23*)3.4.2 响应参数code:001”,data:“result”:*
23、appCode,)3.5 功能级鉴权参数样例(返回标识符)3.5.1 请求参数1ZppToken:QWEWQESDA=SDASDWQESKJALSKXVUXN稣J#$XBCMSDKQWHE4309SDASDKJNASJKJHKJHZXNCZMXNCBZ.”,taskClass:7应用令牌样例:type:user。“expireAt”:*2019-05-2310:43:23”,*createTime,:*2019-05-2310:34:05*,H八I”nappCode:a,action:online,id:*9cdadf6e00e039127751d8378484cl9cNwST370v,typ
24、e”:*app*,expireAt:*2019-05-2310:37:05*)3.5.2 响应参数code:001”,data:“result”:*resourceCode,)3.6 功能级鉴权参数样例(返回地址)3.6.1 请求参数ZppToken:QWEwQESDA=SDASDWQESKJALSKXVUXNKJ#$XBCMSDKQwHE4309SDASDKJNASJKJHKJHZXNCZMXNCBZ.“taskClass:7)应用令牌样例:“appToken”:*userToken*:*createTime:*2019-05-2310:38:23*,*orgCode*:*3*,HbHfHn
25、ame:2,”14*r-*mid:5,challenge:b,action:online,H1Hrpd:7,id:e7e7a75e98bd89b7c80ce8517294e76d”,cnv:pc,A*.*Hfftype:user,expireAt”:*2019-05-2310:43:23*),createTime”:*2019-05-2310:34:05*,appCode:a,action:online,id”:*9cdadf6e00e039127751d8378484c19cNwST370v”,“type:app,*expireAt*:*2019-05-2310:37:05*)3.6.2 响
26、应参数code:001”,data:*result*:z,resourceUrl,)3.7 数据级鉴权参数样例3.7.1 请求参数“taskClass”:“8”,“resourceId:,aTesourceEnNameM:“GLOBAL_PERSON,GLOBALCERT,GLOBAJDEPARTMEVrappToken”:werwer23423edsr23423r4545t56y5ty4564534234234234234234wcwq3.7.2响应参数“code”:“001”,“message:成功“result:“GLOBAL_PERSO、”:BSID,G?_SOURCE_132,BSX
27、IDm,rtGLOBAL_CERTM:“”,“GLOBAL_DEPARTMENT”:“CODE”3.8 接口级鉴权参数样例3.8.1 请求参数DATASETname=WA_C0MMONJ)IoOO0rmk=w数据交互通用信息”ITEMkey=HoloOO6val=w010000chn=发起节点的系统标识”/ITEMkey=H(HoOO7val=350200“Chn=目的节点的系统标识”/ITEMkey=wI010010mval=02Chn=业务服务类型”/DATASETname=WA_COMMON_01000,rmk=w用户认证和公共角色信息”ITEMkey=I010026wval=admin
28、”eng=vUSER,NAMEwChn=用户名”/ITEMkey=nI010025wval=0“eng=ROLEjrYPEChn=角色类型”/ITEMkey=IOloO27Va1=eng=COoKIES”chn=w通行字”-APl鉴权行为请求必填!-PI鉴权行为请求必填!-PI鉴权行为请求必填ITEMkey=z,G030004,Va1=”eng=APP而&应用ID”!-PI鉴权行为请求必填ITEMkey=1040011”val=,weng=vLAST_EXAMINE_RESULTChn=”最终审批结果”一签名(提请审批人员ID的HASH、标识信息HASH、审批表图像HASH、审批表关键字段HA
29、SH、系统最终审批结果、最终审批时间、审批记录ID、审批中心ID,最终审批人证书)ITEMkey=B040029mval=,weng=LAST.APPROVAL-SlGN”Chn=”最后审批人签名”DATASETname=WACOMMON_O10010mrmk=查询下发通用信息”!一请求中如有此标识,需要接口随机返回新测试数据10条ITEMJ07001val=w02,reng=TEST_FLAG接口测试”/)DATASETname=WA_C0MM0N_01001,rmk=w查询下发要求返回通用信息”3.8.2 响应参数DATASETname=*WA_C0MM0N_010000*rmk=数据交互
30、通用信息”GTEMkey=H010006val=010000Chn=发起节点的系统标识”/ITEMkey=I010026val=admineng=*USER_NAME*Chn=用户名/ITEMkey=*I010025*val=*0*eng=*ROLE_TYPE*Chn=角色类型ITEMkey=*H100059*val=z,orgCode*: 3, name : 2 , H 1lmid : 5 , Challenge : 6 ,eng=*TASK_CLASS*Chn=任务类型/ITEMkey=val=eng=SCENE_CODEChn=场景”/ITEMval=50eng=*SEARCH_RESU
31、LT_MAXNUM*rmk=key=1010017*fmt=Chn=最多总返回条数“ITEMval=z,10*eng=SEARaLRESULT_COUNTrmk=key=1010019*fmt=Chn=一次查询返回结果数ITEMval=N0eng=wSEARCH_DETAILOPTIANwrmk=key=*1010020fmt=Chn=是否要附带全文数据”ITEMkey=*H010005*va1=*meiyacx0045612378644151*Chn=线索ID”/DATASETname=WA_COMMO010011rmk=查询下发要求返回通用信息”DATASETname=*WA_BASIC_
32、0009*rmk=IPRANGE”3.9 应用权限变更通知参数样例3.9.1 请求参数1token:QWEWQESDA=SDASDWQESKJALSKXVUXNKJ#$XBCVSDKQwHE4309SDASDKJNASJKJHKJHZXNCZMXNCBZ.)用户令牌样例:”.*.2action:online,pid:7,id:e7e7a75e98bd89b7c80ce8517294e76d”,env:pc,type:user,*expireAt*:z,2019-05-2310:43:23*)3.9.2 响应参数code:001”,msg:3.10 功能权限变更通知参数样例3.10.1 请求参数appToken:QWEWQESDA=SDASDWQESKJALSKXvUXNKJ#$XBCMSDKQWHE4309SDASDKjNASJKJHKJHZXNCZMXNCBZ.应用令牌样例:appTokenw:*userToken*:*createTime*:*2019-05-2310:38: