Appearance
对接开发应用
应用创建设置完成后,需要开发商完成用户权限的对接并测试完成后可申请正式上线。所有后端接口调用必须携带合法令牌,具体令牌授权签名方法详见第二章节。(接口授权签名是接口调用必要条件,接口说明中不再赘述)
原理: 用户点击应用时平台自动追加用户 stoken
参数,应用通过接口解析用户信息,自行设置本应用登录状态并跳转相应的页面。
解释: 平台:智慧助残数字化平台;应用:第三方创建业务应用。
前缀: 测试环境(https://xxx.xxx/disable-mis-bidp),正式环境(另外通知)。
1.用户信息接口
根据登录用户会话码解析对应登录用户信息,会话码由平台在链接上传送过来,会话码时效和平台一致。三端用户对应接口各不相同,请根据应用属性选择接口进行对接。
yaml
URL(治理端): /acis/udsa/userbytoken
URL(服务端): /acis/udsd/szzcbytoken
URL(协同端): /acis/udsx/userbytoken
Method: POST
Content-Type: application/x-www-form-urlencoded
Accept: */*
Request:
Parameter | Type | Description |
---|---|---|
stoken | String | 获取登录会话码(由主程序传值过来) |
Response:
Field | Type | Description |
---|---|---|
meta | Meta | 响应头部 |
success | boolean | 状态(true:成功/false:失败) |
message | String | 中文消息 |
data | Object | 响应内容 |
useruuid | String | 登录用户标识 |
username | String | 登录用户名称 |
areacode | String | 登录用户区划 |
deptuuid | String | 登录部门标识 |
deptname | String | 登录部门名称 |
2.用户角色接口(可选)
根据应用标识、用户标识、用户区划获取用户被授权的角色列表,针对已有角色-菜单管理功能的应用,仅需将角色创建到平台上,通过本接口获取角色,用角色代码(可以是本地角色 ID)对应本地系统角色,完成权限解析,实现用户安全登录。需先通过指定接口进行应用注册,获取相应的应用 ID。
yaml
URL: /acis/udsa/roleset
Method: POST
Content-Type: application/x-www-form-urlencoded
Accept: */*
Request:
Parameter | Type | Description |
---|---|---|
aid | String | 应用标识 在 应用开放平台 中应用基本信息中获取 |
uid | String | 用户标识 从 用户信息接口 中获取 |
uac | String | 用户地区 从 用户信息接口 中获取 |
Response:
Field | Type | Description |
---|---|---|
meta | Meta | 响应头部 |
success | boolean | 状态(true:成功/false:失败) |
message | String | 中文消息 |
data | Array | 响应内容 数组 |
uid | String | 接口访问授权码 |
uname | String | 授权码有效时长(秒) |
roleId | String | 角色标识 |
roleCode | String | 角色代码 |
roleLeve | String | 角色级别(2:省级/4:市级/6:区县/9:街镇/12:村社) |
roleName | String | 角色名称 |
3.用户权限接口(可选)
根据应用标识、用户标识、用户区划获取用户被授权的权限列表,应用可以完全依托于平台完成权限控制,通过本接口获取权限列表,可以完成动态菜单渲染或者菜单权限控制,实现用户安全登录。
yaml
URL: /acis/udsa/permits
Method: POST
Content-Type: application/x-www-form-urlencoded
Accept: */*
Request:
Parameter | Type | Description |
---|---|---|
aid | String | 应用标识 在 应用开放平台 中应用基本信息中获取 |
uid | String | 用户标识 从 用户信息接口 中获取 |
uac | String | 用户地区 从 用户信息接口 中获取 |
Response:
Field | Type | Description |
---|---|---|
meta | Meta | 响应头部 |
success | boolean | 状态(true:成功/false:失败) |
message | String | 中文消息 |
data | Array | 响应内容 数组 |
uid | String | 接口访问授权码 |
uname | String | 授权码有效时长(秒) |
roleId | String | 角色标识 |
roleCode | String | 角色代码 |
roleLeve | String | 角色级别(2:省级/4:市级/6:区县/9:街镇/12:村社) |
roleName | String | 角色名称 |
permId | String | 权限/菜单 标识 |
permPid | String | 权限/菜单 父级标识 |
permNkey | String | 权限/菜单 代码 |
permName | String | 权限/菜单 名称 |
permIcon | String | 权限/菜单 图标(开放平台自定) |
permPath | String | 权限/菜单 路径(用于渲染菜单) |
permSort | String | 权限/菜单 排序 |
4.用户三方接入(可选)
根据用户基本信息获取用户详细信息,用户详情主要包括用户的身份证号、姓名、手机号、行政区划等。
yaml
URL: /acis/udsa/authorz
Method: POST
Content-Type: application/json
Accept: */*
Request:
Parameter | Type | Description |
---|---|---|
appid | String | 应用的标识(固定为XXX应用) |
agent | String | 客户端类型(PURI:电脑端/MURI:手机端/TURI:大屏端) |
useruuid | String | 用户的标识(固定为 XXX 用户) |
parameters | Object | 应用需参数(如:sobject/servFrom 等) |
Request:
Field | Type | Description |
---|---|---|
meta | Meta | 响应头部 |
success | boolean | 状态(true:成功/false:失败) |
message | String | 中文消息 |
data | Object | 跳转链接 |