功能接口
APP初始化服务
接口名称:appInit
Dubbo调用: msAppInitService
接口描述:客户端初始化请求接口,聚合app在启动时需要进行的多次网络请求的接口, 解决多次网络请求会导致客户端的性能问题和网络流量增加问题。 所以抽象出客户端初始化接口,把启动时用到的网络请求聚合成为一次网络请求, 启动时一次网络请求即可获取多项数据, 减少网络请求次数,从而提高app性能。 目前客户端初始化接口返回splash和版本更新两部分业务。
动态菜单服务
接口名称:remoteUI
Dubbo调用: msRemoteUIService
接口描述:
客户端开发平台封装了一套完整的动态UI功能,使得开发人员可在服务端动态的修改NativeUI,客户端开发人员只需在应用启动时从服务端获取到动态UI并在需要动态UI时初始化即可。动态UI提供了一套完整的UI获取及显示功能,动态UI可以从服务端获取也可以从本地获取, 相比静态UI更加灵活,易于维护更新,动态UI数据通过Json获取,动态UI结构为树形结构,用哈希表以动态UI的ID为索引存储和读取,速度快效率高。
NaviteUI动态菜单配置接口给客户端提供动态菜单服务端配置信息, 通过该接口可动态获取和设置客户端需要显示的菜单, 对运营、推广有很大的方便, 结合AI和大数据,可根据每个用户习惯提供不同的UI展示内容和效果,为用户提供个性化的App。 客户端NativeUI动态菜单配置信息获取接口。 使用详情参考动态NativeUI框架
Splash服务
接口名称:loadingInfo
Dubbo调用:msLoadingInfoService
接口描述:客户端启动时Splash配置信息获取接口, 在管理后台进行Splash数据的配置,如Splash图片、显示时间、显示时常、点击跳转地址等信息的配置,客户端即可快速集成一套为app定制化的广告、运营场景。 使用详情参考Splash组件
版本更新服务
接口名称:versionUpgrade
Dubbo调用:msVersionService
接口描述:客户端版本升级接口信息获取接口, 在后台配置每个版本使用的升级方式, 是否可以升级,升级提示内容等信息, Android可直接下载,iOS可配置跳转app store进行版本更新, 开发者即可快速集成版本升级功能, 从而把主要精力放在主要业务。 使用详情参考应用更新
Web本地化插件服务
接口名称:webPlugins
Dubbo调用:msGetWebPluginsService
接口描述:移动端集成了Web本地化实现的整体技术方案, Web本地化插件的集成,可明显提高Web性能, 增加客户端的灵活性, 并且屏蔽平台差异。 Web本地化模版更新的策略和数据,需要通过管理后台进行配置,然后通过该接口获取, 客户端进行安全校验和更新。 使用详情参考H5容器和离线包-PaaS服务
Web白名单服务
接口名称:whiteList
Dubbo调用:msWhiteListService
接口描述:移动开发平台提供了Web本地化的整体技术解决方案和银行经验, 在此基础上进行web网络请求的白名单限制, 自动实现过滤功能,避免出现涉黄、涉恐信息。 白名单功能支持开发者自定义网络请求的白名单, 更新的的白名单信息可通过该服务到达客户端, 进行客户端本地数据的过滤。使用详情参考H5容器和离线包-PaaS服务
小程序配置信息服务
接口名称: miniAppInfo
Dubbo调用:msQueryMiniAppInfoService
接口描述:小程序是移动开发平台提供面向未来的以东段生态环境,小程序的logo、名称、描述、权限等信息在后台配置之后,可以通过该接口拉去最新的配置信息, 客户端根据最新的配置信息,进行小程序的更新。 使用详情参考小程序-后台接口
小程序请求转发服务
接口名称:msHttpProxyService
接口描述:小程序请求转发接口是给小程序提供的业务转发服务接口,是小程序实现管控功能的重要手段。 通过小程序管理平台进行配置的api才可以进行请求转发,不在白名单中的域名或者api是无法通过小程序进行业务数据请求。使用详情参考小程序-后台接口
网络协议设计
网络请求上行参数分通用字段和业务字段两部分,通用字段放在header中, 业务字段放到body中。
字段名称 | 字段类型 | 字段描述 | 是否必须 |
---|---|---|---|
header | object | 请求通用字段 | 是 |
body | object | 请求业务字段 | 否 |
body见各接口业务参数
body见各接口业务参数
header通用参数
字段名称 | 字段类型 | 字段描述 | 是否必须 |
---|---|---|---|
appId | String | 应用ID | 是 |
appVersion | String | 应用版本号 | 是 |
ffVersion | String | Firefly SDK版本号 | 是 |
transId | String | 请求function名称 | 是 |
appExt | String | 否 | |
custType | String | 否 | |
signedMicroFlag | String | 否 | |
reqSeq | String | 0 | 否 |
net | Object | 网络信息,参考net 网络信息 | 是 |
device | Object | 设备信息,参考device 设备信息 | 是 |
net网络信息
字段名称 | 字段类型 | 字段描述 | 是否必须 |
---|---|---|---|
ip | String | IP地址 | 是 |
netType | String | 网络类型 | 否 |
isp | String | 运营商,如中国移动 | 否 |
ssid | String | WIFI服务标识 | 否 |
lac | String | 位置区域码 | 否 |
cid | String | 基站编号 | 否 |
device设备信息
字段名称 | 字段类型 | 字段描述 | 是否必须 |
---|---|---|---|
osType | String | 设备类型 01-iOS,02-Android,03-iPad,04-Windows Phone | 是 |
osVersion | String | 设备版本号 | 是 |
brand | String | 厂商,如xiaomi、HUAWEI | 是 |
model | String | 设备型号,如samsungSM-N9005 | 是 |
uuid | String | 设备唯一标识 | 是 |
imei | String | IMEI号 | 是 |
mac | String | MAC地址 | 是 |
nfc | String | 是否支持NFC,0-不支持,1-支持 | 是 |
isRoot | String | 是否ROOT提权,0-未提权,1-提权 | 是 |
imsi | String | SIM卡序列号 | 否 |
错误码
字段名称 | 字段类型 | 字段描述 | 是否必须 |
---|---|---|---|
AAAAAA | String | success | 是 |
other | String | failed | 是 |