小程序配置信息接口

小程序是移动开发平台提供面向未来的以东段生态环境,小程序的logo、名称、描述、权限等信息在后台配置之后,可以通过该接口拉去最新的配置信息, 客户端根据最新的配置信息,进行小程序的更新

接口说明

接口名称: miniAppInfo

Dubbo调用:msQueryMiniAppInfoService

接口描述:小程序配置信息获取

入参

header通用参数

参考header通用参数

业务参数

字段名称 字段类型 字段描述 是否必须
code String
version String 版本

出参

字段名称 字段类型 字段描述 是否必须
ffMiniAppInfoList List

ffMiniAppInfoList

字段名称 字段类型 字段描述 是否必须
miniAppId String 小程序ID
miniAppIdAlias String 小程序ID的MD5
miniAppName String 小程序名称
miniAppDesc String 小程序描述
miniAppIcon String 小程序图标
miniAppVersion String 小程序版本
scope String 小程序权限scope
resloadWhiteList String 图片加载白名单(P2)
fullMd5 String 小程序全量离线包MD5
fullDownloadUrl String 小程序全量离线包url
loadType String 小程序打开类型
urlPrefix String 前缀
sdkMinVer String 小程序支持的小程序sdk的最低版本
indexRoute String
accessName String
ext String 扩展字段

样例

dubbo协议接入:

请求url

http://localhost:9102/gw/hk_e_app/msQueryMiniAppInfoService.do

请求数据格式:

{
    "request": {
        "header": {
            "appId": "1",
            "appVersion": "4.41",
            "ffVersion": "4.0",
            "transId": "miniAppInfo",
            "appExt": "1",
            "custType": "100",
            "signedMicroFlag": "0",
            "net": {
                 "ip": "127.0.0.1",
                 "netType": "WIFI_oa-test",
                 "isp": "中国移动",
                 "ssid": "oa-test",
                  "lac": "4203",
                  "cid": "10732931"
             },
            "device": {
                  "osType": "03",
                  "osVersion": "8.0.0",
                  "brand": "samsung",
                  "model": "SM-G9500",
                  "uuid": "2e2bc2402301ea3e1e021362dd6b7a1e",
                  "imei": "357052091333047",
                  "mac": "00:9D:6B:32:00:24",
                  "nfc": "1",
                  "isRoot": "0",
                  "imsi": "8986003915187a258429"
            },
            "reqSeq": "0"
     },
     "body": {
          "code":"qHwgaSkXKx6tO4jc",
           "version":"4.1"
       }
   }
}

http协议接入:

请求url

http://localhost:8080/ffpaas/miniapp/minAppInfos.json

请求数据格式:

{ 
    "request": {
        "header": {
            "appId": "1",
            "appVersion": "4.41",
            "ffVersion": "4.0",
            "transId": "miniAppInfo",
            "appExt": "1",
            "custType": "100",
            "signedMicroFlag": "0",
            "net": {
                 "ip": "127.0.0.1",
                 "netType": "WIFI_oa-test",
                 "isp": "中国移动",
                 "ssid": "oa-test",
                  "lac": "4203",
                  "cid": "10732931"
             },
            "device": {
                  "osType": "03",
                  "osVersion": "8.0.0",
                  "brand": "samsung",
                  "model": "SM-G9500",
                  "uuid": "2e2bc2402301ea3e1e021362dd6b7a1e",
                  "imei": "357052091333047",
                  "mac": "00:9D:6B:32:00:24",
                  "nfc": "1",
                  "isRoot": "0",
                  "imsi": "8986003915187a258429"
            },
            "reqSeq": "0"
     },
     "body": {
          "code":"qHwgaSkXKx6tO4jc",
          "version":"4.1"
       }
   }
}

dsdl配置

节点配置

  • 创建服务节点, 节点名称为msQueryMiniAppInfoService
  • 添加节点配置信息
msQueryMiniAppInfoService$applicationName,true

说明:

applicationName修改为应用

xml参数配置

  • 创建节点,节点名称为interface-mapping
  • 添加配置参数信息,如下
xml version="1.0" encoding="UTF-8"?>

<interface name="msQueryMiniAppInfoService" description="test" auth="false">
    <configs>
        <config key="accessLog" value="true"/>
        <config key="transDataRecordMode" value="on"/>
        <config key="isCheckRole" value="false"/>
        <config key="productId" value="ECommon"/>
        <config key="signature" value="userId|操作员"/>
    configs>
    <input>
        <param name="code" description="小程序ID的md5" type="String" optional="true"/>
        <param name="version" description="小程序版本" type="String" optional="true"/>
    input>

    <output>
        <param name="returnCode" description="处理结果" type="Map" optional="false">
            <param name="code" description="返回码" type="String" optional="false"/>
            <param name="message" description="返回信息" type="String"/>
            <param name="type" description="处理结果类型" type="String" optional="false"/>
        param>

        <param name="loadType" description="loadType" type="String"/>
        <param name="fullDownloadUrl" description="fullDownloadUrl" type="String"/>
        <param name="miniAppId" description="miniAppId" type="String"/>
        <param name="accessName" description="accessName" type="String"/>
        <param name="sdkMinVer" description="sdkMinVer" type="String"/>
        <param name="urlPrefix" description="urlPrefix" type="String"/>
        <param name="fullMd5" description="fullMd5" type="String"/>
        <param name="miniAppIdMd5" description="miniAppIdMd5" type="String"/>
        <param name="miniAppName" description="miniAppName" type="String"/>
        <param name="scope" description="scope" type="List"/>
        <param name="miniAppVersion" description="miniAppVersion" type="String"/>
        <param name="miniAppDesc" description="miniAppDesc" type="String"/>
        <param name="indexRoute" description="indexRoute" type="String"/>
    output>
interface>