nscmfs web接口文档 - rexliu2018/rexliu2018.github.io GitHub Wiki

nscmfs-web接口文档

接口大类

[toc]

1.扫一扫白名单接口

1.1接口功能

校验app端传入的url链接是否是白名单

1.2接口地址

sit：http://ns-sit.cnsuning.com/nscmfs-web/whiteUrl/checkWhiteUrl.do?key={key}&version={version}&source={source}
pre：http://ns-pre.cnsuning.com/nscmfs-web/whiteUrl/checkWhiteUrl.do?key={key}&version={version}&source={source}
xgpre：http://ns-xgpre.cnsuning.com/nscmfs-web/whiteUrl/checkWhiteUrl.do?key={key}&version={version}&source={source}
prd： http://ns.suning.com/nscmfs-web/whiteUrl/checkWhiteUrl.do?key={key}&version={version}&source={source}

1.3返回格式

JSON

1.4请求方式

GET

1.5请求参数

参数 必选 类型 默认值 说明 备注
key ture string null url 需要utf-8 编码encode
version true String null 客户端版本号
source true String null 来源 ios，android，wap

请求示例

http://ns-pre.cnsuning.com/nscmfs-web/whiteUrl/checkWhiteUrl.do?key=http%3A%2F%2Fcn.suning.cn%2F%23%2Findex%2Fsnxd_index_jx%3FsnstoreTypeCode%3D100005&version=1.0.0&source=ios

1.6返回字段

返回字段 子节点 字段类型 说明
resultCode string 返回结果状态。0：正常；1：错误。
resultMsg string 错误说明
resultData code string 返回码
msg string 返回文案

返回示例

是白名单：
{
    "resultCode": "0",
    "resultMsg": "success",
    "resultData": {
        "code": "0001"
    },
    "v": "1.0.0"
}
不是白名单：
{
    "resultCode": "0",
    "resultMsg": "success",
    "resultData": {
        "code": "0004",
        "msg": "您扫描的网址可能存在风险，是否打开此链接？"
    },
    "v": "1.0.0"
}

1.7备注

2.获取3D组件接口（未测试，暂未发布）

2.1接口功能

获取所有菜单

2.2接口地址

sit：http://ns-sit.cnsuning.com/nscmfs-web/touchMenu/getAllMenu/{key}\_{version}\_{source}\_{callback}.htm
pre：http://ns-pre.cnsuning.com/nscmfs-web/touchMenu/getAllMenu/{key}\_{version}\_{source}\_{callback}.htm
xgpre：http://ns-xgpre.cnsuning.com/nscmfs-web/touchMenu/getAllMenu/{key}\_{version}\_{source}\_{callback}.htm
prd： http://ns.suning.com/nscmfs-web/touchMenu/getAllMenu/{key}\_{version}\_{source}\_{callback}.htm

2.3返回格式

JSON

2.4请求方式

GET

2.5请求参数

参数 必选 类型 默认值 说明 备注
key ture string null url 需要utf-8 编码encode
version true String null 客户端版本号
source true String null 来源 ios，android，wap

请求示例

http://ns-pre.cnsuning.com/nscmfs-web/touchMenu/getAllMenu/touchMenu_1.0.0_ios_.htm

2.6返回字段

返回字段 子节点 字段类型 说明 备注
resultCode string 返回码 0正常，1异常
resultMsg string 返回信息
resultData name string 名称
url string 跳转链接
picture string 图片
v string 版本号

返回示例

{
    "resultCode": "0",
    "resultMsg": "success",
    "resultData": [
        {
            "name": "搜索",
            "url": "http://ns.suning.com/?snstoreTypeCode=200002",
            "picture": "http://presslres.suning.com/project/cmsWeb/act/snxd/applet/images/395/detail/sousuo.png"
        },
        {
            "name": "扫一扫",
            "url": "http://ns.suning.com/?snstoreTypeCode=260007",
            "picture": "http://presslres.suning.com/project/cmsWeb/act/snxd/applet/images/395/detail/saoyisao.png"
        },
        {
            "name": "会员卡",
            "url": "http://ns.suning.com/?snstoreTypeCode=240011",
            "picture": "http://presslres.suning.com/project/cmsWeb/act/snxd/applet/images/395/detail/huiyuanka.png"
        },
        {
            "name": "付款码",
            "url": "http://ns.suning.com/?snstoreTypeCode=300001",
            "picture": "http://presslres.suning.com/project/cmsWeb/act/snxd/applet/images/395/detail/fukuanma.png"
        }
    ],
    "v": "1.0.0"
}

2.9备注