应用信息接口

主要使用场景:该类接口主要使用场景是应用列表展示、应用详情查看功能

1、获取应用基本信息

开发者可以通过该接口获取应用的信息

请求说明

url /appInfo/getAppBaseInfo
协议 post

参数说明

序列号 字段名 约束 类型 说明
1 appId 必选 String 应用Id

返回说明

序列号 字段名 约束 类型 说明
1 retCode 必选 String 返回码
2 retDesc 必选 String 返回码描述
3 data 必选 JSON 返回的应用信息
3.1 appId 必选 String 应用Id
3.2 appName 必选 String 应用名称
3.3 appUrl 必选 String 应用运行的url
3.4 appImage 必选 String 应用图标,绝对路径
3.5 appIcon1 必选 String 应用截图1,绝对路径
3.6 appIcon2 必选 String 应用截图2,绝对路径
3.7 personScope 必选 String 适用人群(0-学生,1-老师,2-家长,3-其他),多个值用逗号分隔“,“
3.8 appLvl 必选 String 使用级别(0-国家级,1-省级,2-市级,3-区县级,4-机构)
3.9 appDesc 必选 String 应用简介
3.10 appClassification 可选 String 应用分类,枚举值: app_classify_02:备课授课 app_classify_04:互动课堂 app_classify_06:作业测评 app_classify_07:数字图书馆 app_classify_08:语言学习 app_classify_09:协作互助 app_classify_10:网络课程 app_classify_11:网络教研 app_classify_99:其他
3.11 providerName 可选 String 应用提供商名称
3.12 providerId 可选 String 应用提供商Id
3.13 eduType 可选 String 教育类型(edu_type_0-基教;edu_type_1-职教)
3.14 evaluationUrl 必选 String 应用评价地址
3.15 reportUrl 必选 String 应用举报地址
3.16 mobileType 必选 String 应用小类 0 IOS手机端 ;1安卓手机端;2 PC端;3 Web端;4H5应用;5微信小程序
3.18 appShortName 必选 String 应用简称
3.17 chargeStandard 必选 String 收费标准:0:免费;1:机构购买,2:收费
3.19 mobileImage 可选 String H5图标

示例

请求报文:
{
	"appId":"257fa1edab0011e6a119843a4b3285ee"
}
应答报文:
{
    "data": {
        "appId": "257fa1edab0011e6a119843a4b3285ee",
        "appName": "应用******",
        "appUrl": "http://www.spapps.com/appLogin",
        "appImage": "http://www.bmp-web.com/app/FGHJK.jpg",
        "appIcon1": "http://www.bmp-web.com/app/VBNBNM1.jpg",
        "appIcon2": "http://www.bmp-web.com/app/VBNBNM2.jpg" ,
        "personScope": "0,1,2,3" ,
        "appLvl": "0" ,
        "appDesc": "这是应用简介",
        "appClassification": "app_classify_02",
        "providerName ": "某某公司",
        "providerId ": "服务商用户Id",
        "eduType": "edu_type_0",
 	     "mobileType": "3",
        "reportUrl": "http://www.bmp-web.com/sysAppreport/",
        "evaluationUrl":"http://www.bmp-web.com/getSpApp/"  
        "chargeStandard": "0",
        "appShortName": "应用简称"     
    },
    "retCode": "000000",
    "retDesc": "成功"
}

2、获取应用信息列表

开发者可以通过该接口获取区域或者机构选用的应用信息列表。

请求说明

url /appInfo/getAppList
协议 post

参数说明

序列号 字段名 约束 类型 说明
1 usessionId 可选 String 服务体系用户会话id,不传则获取区域和机构选用过的应用;传递则查询登录用户可以查看到的应用。
2 pageNo 可选 Int 获取记录的页数,默认1
3 pageSize 可选 Int 获取每页的条数,默认10,最大值500
4 eduType 可选 String 教育类型(edu_type_0-基教;edu_type_1-职教),不填默认返回所有类型

返回说明

序列号 字段名 约束 类型 说明
1 retCode 必选 String 返回码
2 retDesc 必选 String 返回码描述
3 data 必选 JSON 返回的应用列表信息
3.1 count 必选 Int 分页总条数
3.2 dataList 必选 JSON[] 返回的应用列表信息
3.2.1 appId 必选 String 应用Id
3.2.2 appName 必选 String 应用名称
3.2.3 appUrl 必选 String 应用运行的url
3.2.4 appImage 必选 String 应用图标,绝对路径
3.2.5 appIcon1 必选 String 应用截图1,绝对路径
3.2.6 appIcon2 必选 String 应用截图2,绝对路径
3.2.7 personScope 必选 String 适用人群(0-学生,1-老师,2-家长,3-其他),多个值用逗号分隔”,”
3.2.8 appLvl 可选 String 使用级别(0-国家级,1-省级,2-市级,3-区县级,4-机构,5-个人)
3.2.9 appDesc 必选 String 应用简介
3.2.10 appClassification 可选 String 应用分类,枚举值: app_classify_02:备课授课 app_classify_04:互动课堂 app_classify_06:作业测评 app_classify_07:数字图书馆 app_classify_08:语言学习 app_classify_09:协作互助 app_classify_10:网络课程 app_classify_11:网络教研 app_classify_99:其他
3.2.11 providerName 可选 String 应用提供商名称
3.2.12 providerId 可选 String 应用提供商Id
3.2.13 eduType 可选 String 教育类型(edu_type_0-基教;edu_type_1-职教)
3.2.14 appMode 可选 String 建设模式(mode_0-政府汇聚;mode_1-政府建设)
3.2.15 appTag 可选 String 应用标签(多个标签时,逗号分隔)
3.2.1.6 evaluationUrl 必选 String 应用评价地址
3.2.1.7 reportUrl 必选 String 应用举报地址
3.2.18 intoSpace 必选 String 个人应用是0 非个人应用是1
3.2.19 mobile_type 必选 String 应用小类 0 IOS手机端 ;1安卓手机端;2 PC端;3 Web端;4H5应用;5微信小程序
3.2.20 appShortName 必选 String 应用简称

示例

请求报文:
{
	"pageNo":1,
	"pageSize":1
}
应答报文:
{
    "retCode": "000000",
     "retDesc": "成功",
    "data":{
     "count": 150,
     "dataList": [{
        "appId": "257fa1edab0011e6a119843a4b3285ee",
        "appName": "应用******",
        "appUrl": "http://www.spapps.com/appLogin",
        "appImage": "http://www.bmp-web.com/app/FGHJK.jpg",
        "appIcon1": "http://www.bmp-web.com/app/VBNBNM1.jpg",
        "appIcon2": "http://www.bmp-web.com/app/VBNBNM2.jpg" ,
        "intoSpace": "0",
        "personScope": "0,1,2,3" ,
        "appLvl": "0" ,
        "appDesc": "这是应用简介",
	"mobileType": "3",
        "appClassification": "app_classify_02",
        "providerName": "某某公司",
        "providerId ": "服务商用户Id",
        "eduType": "edu_type_0"
	"reportUrl": "http://www.bmp-web.com/sysAppreport/",	
	"evaluationUrl":"http://www.bmp-web.com/getSpApp/",
	"appShortName": "应用简称"
    }]
   }   
}

3、获取微件分页列表信息

获取微件分页列表信息

请求说明

url /widgetInfo/getWidgetList
协议 post

参数说明

序列号 字段名 约束 类型 说明
1 pageNo 可选 String 页码
2 pageSize 可选 String 每页记录数
3 usessionId 必选 String 用户登录sessionId

返回说明

序列号 字段名 约束 类型 说明
1 retCode 必选 String 返回码 000000:成功 200001: 必选参数为空 300006: 用户会话票据失效
2 retDesc 必选 String 返回码描述
3 data 必选 JSON 返回的结果集
3.1 count 必选 Int 分页总条数
3.2 dataList 必选 JSON 返回的微件列表信息
3.2.1 pkwidget 可选 String 微件Id
3.2.2 widgetName 可选 String 微件名称
3.2.3 widgetType 可选 String 微件类型 1:一个窗口, 2:两个窗口, 3:三个窗口
3.2.4 personScope 可选 String 适用人群(逗号隔开) 0:学生; 1:老师; 2:家长; 3:机构
3.2.5 widgetDesc 可选 String 微件描述
3.2.6 sizeX 可选 String 横向宽度
3.2.7 sizeY 可选 String 纵向高度
3.2.8 slideHeight 可选 String 高度支持滑动: 0支持;1不支持;
3.2.9 widgetLogo 可选 String 微件logo地址
3.2.11 appName 可选 String 绑定应用名称
3.2.12 providerName 可选 String 服务提供商名称
3.2.13 spWidgetTabList 可选 JSON 返回的微件窗口信息
3.2.13. pkId 可选 String 绑定应用名称
3.2.13. tabName 可选 String 微件窗口名称
3.2.13. tabUrl 可选 String 微件窗口URL

示例

请求报文:
{
"pageNo":1,
"pageSize":10,
"usessionId":"a92301b0-14f4-41e9-a301-b014f411e961"
}


应答报文:
{
    "retCode": "000000",
     "retDesc": "成功",
    "data":{
     "count": 150,
     "dataList": [{
        "pkwidget": "ccLTxqYSD0dj1pQQtqSg9Qe3VzbLP451",
        "widgetName": "互动电影微件2",
        "widgetType": "2",
        "personScope": "0,3",
        "widgetDesc": "互动电影微件2号",
        "sizeX": "80",
        "sizeY": "80",
        "slideHeight": "0",
        "widgetLogo": "http://211.153.23.3:40010/bmp-web/spApp/icon/20180910/1812756559_png",
        "pkApp": "jJCbhEzpIYaNwZzcaKScuLcxEX3g0VPa",
        "appName": "互动电影",
        "providerName": "sp_demo",
        "spWidgetTabList": [
          {
            "pkId": "a3f1cf3a38dc4c78b1cf3a38dccc7857",
            "tabName": "窗口1",
            "tabUrl": "https://www.sina.com.cn/"
          },
          {
            "pkId": "f3683643dd654a8aa83643dd65ea8a18",
            "tabName": "窗口2",
            "tabUrl": "https://weibo.com/?c=spr_web_sq_firefox_weibo_t001"
          }
        ]
    }]
   }   
}

4、校验应用状态

服务商可以通过该接口校验应用是否有效、可用。

请求说明

url /appInfo/validateAppStatus
协议 post

参数说明

序列号 字段名 约束 类型 说明
1 appId 必选 String 应用id

返回说明

序列号 字段名 约束 类型 说明
1 retCode 必选 String 返回码 000000:正常 303001: 下线或者未选用
2 retDesc 必选 String 返回码描述

示例

请求报文:
{
	"appId":"257fa1edab0011e6a119843a4b3285ee"
}
应答报文:
{
  "retCode": "000000",
  "retDesc": "正常"
}

5、获取微件信息

获取微件基本信息

请求说明

url /widgetInfo/getWidgetBaseInfo
协议 post

参数说明

序列号 字段名 约束 类型 说明
1 widgetId 必选 String 微件ID

返回说明

序列号 字段名 约束 类型 说明
1 retCode 必选 String 返回码 000000:成功 200001: 必选参数为空 300006: 用户会话票据失效
2 retDesc 必选 String 返回码描述
3 data 必选 Json 返回的token对象信息
3.1 pkApp 必选 String 绑定应用Id
3.2 appName 必选 String 绑定应用名称
3.3 pkwidget 必选 String 微件ID
3.4 providerName 必选 Strng 服务提供商名称
3.5 widgetName 必选 String 微件名
3.6 widgetType 必选 String 微件类型 1:一个窗口 2:两个窗口 3:三个窗口
3.8 widgetDesc 必选 String 微件描述
3.8 personScope 必选 String 适用人群(0-学生,1-老师,2-家长,3-机构),多个值用逗号分隔“,“
3.9 sizeX 必选 String 宽度
3.10 sizeY 必选 String 高度
3.11 slideHeight 必选 String 高度支持滑动:0支持;1不支持;
3.12 widgetLogo 必选 String logo图片地址
3.13 widgetLvl 必选 String 适用级别,0:国家级;1:省级;2:地市级;3:区县级;4:机构
3.14 spWidgetTabList 必选 JSON 返回的微件窗口信息
3.14.1 pkId 可选 String 窗口信息id
3.14.2 tabName 可选 String 微件窗口名称
3.14.3 tabUrl 可选 String 微件窗口URL

示例

请求报文:
{
"widgetId":"ccLTxqYSD0dj1pQQtqSg9Qe3VzbLP451"
}


应答报文:
{
  "retCode": "000000",
  "retDesc": "成功",
  "data": {
    "pkwidget": "ccLTxqYSD0dj1pQQtqSg9Qe3VzbLP451",
    "widgetName": "互动电影微件2",
    "widgetType": "2",
    "personScope": "0,3",
    "widgetDesc": "互动电影微件2号",
    "sizeX": "80",
    "sizeY": "80",
    "slideHeight": "0",
    "widgetLogo": "http://211.153.23.3:40010/bmp-web/spApp/icon/20180910/1812756559_png",
    "widgetLvl": "0",
    "pkApp": "jJCbhEzpIYaNwZzcaKScuLcxEX3g0VPa",
    "appName": "互动电影",
    "providerName": "sp_demo",
    "spWidgetTabList": [
      {
        "pkId": "a3f1cf3a38dc4c78b1cf3a38dccc7857",
        "pkwidget": "ccLTxqYSD0dj1pQQtqSg9Qe3VzbLP451",
        "tabName": "窗口1",
        "tabUrl": "https://www.sina.com.cn/"
      },
      {
        "pkId": "f3683643dd654a8aa83643dd65ea8a18",
        "pkwidget": "ccLTxqYSD0dj1pQQtqSg9Qe3VzbLP451",
        "tabName": "窗口2",
        "tabUrl": "https://weibo.com/?c=spr_web_sq_firefox_weibo_t001"