移动端企业域(mobile.DomainController)¶
移动端企业域相关接口:获取有效企业域列表、获取环信(HxIm)即时通讯配置。
- 接口类型:REST 资源(
@Controller继承mobile.common.controller.BaseController,方法标注@ResponseBody,返回Map<String, Object>,由 Spring Jackson 序列化为 JSON 对象;响应非统一Resource,封装为{ "status": 0/1, "message": "ok"/"error", "data": <数据> },详见「公共说明 · 响应结构」) - 基址:
${myapps.context-path.runtime:}/runtime/app - Tag:移动端企业域(源码类级未声明
@Tag,按模块归并)
公共说明¶
- 鉴权(据源码):基址
/runtime/app不在RestSecurityHandlerInterceptor覆盖范围(拦截器仅覆盖/api/runtime/**与/api/rest/bpm/**)。鉴权由RuntimeMvcConfig注册的全局过滤器RuntimeSecurityFilter(URL 模式/*)执行:过滤器解析AuthTimeServiceManager.getWebUser(request),取不到登录用户则返回401(或 SSO 模式下重定向到/signon)。所有端点均需 accessToken,可通过 Cookie / 请求头 / query 参数任一方式传递。源码未在控制器内显式校验登录态(未调用getUserId()/getUser()),完全依赖前置过滤器。 - 响应结构(据源码
mobile.common.controller.BaseController.addActionResult):本控制器所有端点返回Map<String, Object>,结构为: status:0成功,1失败;message:成功ok,失败error;data:业务数据;当业务返回null时data字段缺省;写入前由ESAPI.encode(data)做 XSS 编码。- 与统一
Resource(errcode/errmsg/data/errors)约定不一致,本文档按源码如实记录。
1. 获取企业域列表¶
返回所有状态为 1(有效)的企业域清单(仅含 id 与 name)。
- 接口类型:REST 资源
- 请求方式:
@RequestMapping(未限定 method,支持 GET / POST 等所有方法) - 请求路径:
/domains/list.action(完整:{runtime-context}/runtime/app/domains/list.action) - 鉴权:是(需 accessToken,据源码:
RuntimeSecurityFilter校验登录态) - Tag:移动端企业域
请求参数¶
无业务参数(仅 accessToken)。
请求示例¶
响应¶
结构:Map,固定字段见「公共说明 · 响应结构」。
data:List<Map>,元素结构 { id, name }。
2. 获取环信配置信息¶
返回系统配置中的环信(HxIm)即时通讯配置对象。
- 接口类型:REST 资源
- 请求方式:
@RequestMapping(未限定 method) - 请求路径:
/hx/config.action(完整:{runtime-context}/runtime/app/hx/config.action) - 鉴权:是(需 accessToken)
- Tag:移动端企业域
请求参数¶
无业务参数(仅 accessToken)。
请求示例¶
响应¶
结构:Map,固定字段见「公共说明 · 响应结构」。
data:HxImConfig 对象(字段由 cn.myapps.core.common.model.sysconfig.HxImConfig 定义,常见字段含 appKey、clientId、clientSecret、orgName、appName、host 等,以源码模型为准)。
{
"status": 0,
"message": "ok",
"data": {
"appKey": "myapps#demo",
"clientId": "__CLIENTID__",
"clientSecret": "__CLIENTSECRET__",
"orgName": "myapps",
"appName": "demo",
"host": "a1.easemob.com"
}
}