店铺装修.md 14 KB

1、获取红人店铺获取banner

(method=app.popular.shop.banner) 请求方式:get

请求参数

参数名称 参数类型 可否为空 示例 默认值 备注
shop_id Integer 40 null 店铺ID
client_type String web null 客户端类型
app_type int 0 0 客户端类型 0:有货 1:BLK

注意,通用的头部没有列出。
请求示例 http://192.168.102.205:8080/gateway/?method=app.shop.banner&shop_id=40&debug=XYZ&client_type=web

响应

code为200即为成功且只会返回200,每次都会有响应结果。 响应JSON格式如下所示:

{
  "alg": "SALT_MD5",
  "code": 200,
  "data": {
    "banner": "http://img13.static.yhbimg.com/yhb-img02/2016/10/17/14/0202c5e2d33b6f945db1afba9537fa5c88.jpg?imageMogr2/auto-orient/strip/thumbnail/x{height}/crop/{width}x{height}"
  },
  "md5": "b533f3fcfde4b69a99b11b44cd8b8312",
  "message": "banner"
}

2、根据店铺id查询该店铺下面的品牌

(method=app.shops.getShopsBrands) 请求方式:get

请求参数

参数名称 参数类型 可否为空 示例 默认值 备注
shop_id Integer 40 null 店铺ID

注意,通用的头部没有列出。
请求示例 http://192.168.102.205:8080/gateway/?method=app.shops.getShopsBrands&shop_id=40&debug=XYZ

响应

code为200即为成功且只会返回200,每次都会有响应结果。 响应JSON格式如下所示:

{
  "alg": "SALT_MD5",
  "code": 200,
  "data": [
    {
      "brand_domain": "cracker",
      "brand_ico": "http://img13.static.yhbimg.com/brandLogo/2015/01/20/16/0293592fac7033878fe46a871869b7c334.jpg?imageMogr2/thumbnail/{width}x{height}/extent/{width}x{height}/background/d2hpdGU=/position/center/quality/80",
      "brand_id": 675,
      "brand_name": "Cracker"
    }
  ],
  "md5": "9c7d8aee453f26d5d588f8ec8c2d01f4",
  "message": "query successed!"
}

3、根据店铺id查询红人店铺介绍

(method=app.popular.shops.getIntro) 请求方式:get

请求参数

参数名称 参数类型 可否为空 示例 默认值 备注
shop_id Integer 40 null 店铺ID
uid Integer 40 null 店铺ID
app_type int 0 0 客户端类型 0:有货 1:BLK
app_version String 是5.4 null 店铺ID

注意,通用的头部没有列出。
请求示例 http://192.168.102.205:8080/gateway/?method=app.shops.getIntro&shop_id=40&debug=XYZ

响应

code为200即为成功且只会返回200,每次都会有响应结果。 响应JSON格式如下所示:

{
  "alg": "SALT_MD5",
  "code": 200,
  "data": {
    "is_favorite": "N",
    "is_show_shop_name": "N",
    "mult_brand_shop_type": "1",
    "shop_domain": "cracker",
    "shop_intro": "Cracker成立于2012年由Creamsoda团队与香港著名乐团LMF及24HERBS成员PHAT及KIT共同创立的品牌副线。由于二人于街头时装界别浸淫多年,所以品牌从一开始就贯彻将他们的美式坏孩子风格作为品牌基调,设计上还渗入大量纹身,机车,西岸等等二人最爱的美式文化,并借此打造出多个充满浓厚美式街头风格的时装系列,加上两者对美式街头风格极为熟识,所以成立不久已得到香港大批街头时装爱好者支持。",
    "shop_logo": "http://img11.static.yhbimg.com/yhb-img01/2016/04/28/10/012ef68cd323fe770508799ba1da0cdd0a.PNG?imageMogr2/thumbnail/{width}x{height}/extent/{width}x{height}/background/d2hpdGU=/position/center/quality/80",
    "shop_name": "Cracker",
    "shop_template_type": "2",
    "shops_id": 40
  },
  "md5": "66a2d18f3ffc6add0f2af7b64239df85",
  "message": "query successed!"
}

3、查询红人店铺对应的装修元素

(method=app.popular.shopsdecorator) 请求方式:get

请求参数

参数名称 参数类型 可否为空 示例 默认值 备注
shop_id Integer 40 null 店铺ID
client_type string 是否 web null 客户端类型
app_type int 0 0 客户端类型 0:有货 1:BLK

注意,通用的头部没有列出。
请求示例 http://192.168.102.205:8080/gateway/?method=app.popular.shopsdecorator&shop_id=40&debug=XYZ&client_type=web

响应

code为200即为成功且只会返回200,每次都会有响应结果。

字段说明:

1、module_type

ShopBanner 店招

CarouselImage 轮播图

SingleImage 单图

DoubleImage 双图

TripleImage 三张图

ProductList 商品列表

Title 标题

Video 视频/直播

PC和APP的模块类型一致,通过platform字段去区分是PC和APP。

2、module_style

模块的展示区域,对于PC端,0:1150固定样式,1:975固定样式,2:160固定样式;对于APP,均为0

3、 module_data 模块数据结构

模块的数据结构保持一致,统一为:

{"properties": {"style": ""}, "data": [{"pic": "", "text": "", "linkType": "", "resource": "", "video": ""}]}

所有模块数据都是JSON格式,对象中包含两块内容—properties和data。

properties中存储当前模块的一些属性,比如图片的尺寸,“三张图”模块中图片的展示大小和样式等信息。

data中存储模块的装修内容,统一为数组。比如,店招模块只有一张图片信息,但数据依然是数组格式,只不过数组只包含一个元素。

pic:代表图片的链接,涉及到图片的地方统一取pic的值,比如店招图片、一张图、直播的封面图;

text:代表文本信息,涉及到文本信息的地方统一取text的值,比如导航文字、标题文字;对于直播,这里做个特殊处理,text为对象,数据结构为"text": {"title": "", "content": ""}

linkType:代表跳转类型,目前固定为0、1、2,0是商品分类,1是SKN,2是自定义链接;

resource:代表跳转到的资源,根据linkType做区分,linkType为0,resource对应于"商品分类的标识"(categoryId);linktype为1,resource对应于SKN值;linkType为2,resource对应于自定义的跳转链接;

video: 代表视频相关,对于直播,对应于直播的地址。

响应JSON格式如下所示:

{
  "alg": "SALT_MD5",
  "code": 200,
  "data": {
    "list": [
      {
        "template_id": 558,
        "module_type": "ShopBanner",
        "module_order": 1,
        "module_style": 0,
        "module_data": "{\"properties\": {\"style\": \"\"}, \"data\": [{\"pic\": \"http://img01.yohoboys.com/staticimg/2016/05/19/15/01091c21f2317a64f123f1649fbbccf7ba.png\", \"text\": \"\", \"linkType\": \"\", \"resource\": \"\", \"video\": \"\"}]}"
      },
      {
        "template_id": 558,
        "module_type": "SingleImage",
        "module_order": 2,
        "module_style": 0,
        "module_data": "{\"properties\": {\"style\": \"\"}, \"data\": [{\"pic\": \"http://img01.yohoboys.com/staticimg/2016/05/19/15/01091c21f2317a64f123f1649fbbccf7ba.png\", \"text\": \"\", \"linkType\": \"\", \"resource\": \"\", \"video\": \"\"}]}"
      },
      {
        "template_id": 558,
        "module_type": "Title",
        "module_order": 3,
        "module_style": 0,
        "module_data": "{\"properties\": {\"style\": \"\"}, \"data\": [{\"pic\": \"\", \"text\": \"标题biaoti标题标题biaoti\", \"linkType\": \"\", \"resource\": \"\", \"video\": \"\"}]}"
      }
    ],
    "plateform": "PC",
    "template_type": "2"
  },
  "md5": "284c33020284688c5ea4f2728629add6",
  "message": "popular shops decorator source  data."
}

模块介绍

即上述module_type的取值范围。

  1. ShopBanner -- 店招 示例数据:

    {
        "data": [
            {
                "resource": "",
                "__index": 0,
                "linkType": "",
                "text": "",
                "pic": "http://img12.static.yhbimg.com/yhb-img02/2017/01/06/11/021274d751d321961309ff145bf9d218b2.png",
                "_num": 0,
                "id": 1483672011539691
            }
        ],
        "properties": {}
    }
  2. 轮播图 -- CarouselImage

    示例数据:

    {
        "data": [
            {
                "resource": "272",
                "__index": 0,
                "linkType": "0",
                "text": "",
                "pic": "http://img12.static.yhbimg.com/yhb-img02/2017/01/06/11/02af15c38465d85fc424d23be111e9289b.png",
                "_num": 0,
                "id": 1483672054822947
            },
            {
                "resource": "51147735",
                "__index": 1,
                "linkType": "1",
                "pic": "http://img13.static.yhbimg.com/goodsimg/2015/09/15/11/02a71305e488121e6bd26ce5d99b023dfd.jpg?imageView2/1/w/750/h/234",
                "text": "",
                "_num": 1,
                "id": 1483672054822208
            }
        ],
        "properties": {
            "isModuleMargin": "1"
        }
    }

    说明:

    • 轮播图中至少要有一条数据,最多五条。

    • isModuleMargin用于控制当前模块与下个模块的间距。如果为1,表示有间距;没有该属性,或者属性值为0,表示没有间距。

  3. 标题模块 -- Title

    示例数据:

    {
        "data": [
            {
                "resource": "",
                "__index": 0,
                "linkType": "",
                "text": "热门品类",
                "pic": "",
                "_num": 0,
                "id": 1483672071372424
            }
        ],
        "properties": {
            "isModuleMargin": "0"
        }
    }
  4. 单图模块 -- SingleImage

    示例数据:

    {
        "data": [
            {
                "resource": "270",
                "__index": 0,
                "linkType": "0",
                "text": "",
                "pic": "http://img12.static.yhbimg.com/yhb-img02/2017/01/06/11/02a5d549d4abc3b23d5991101afcfe0ab7.png",
                "_num": 0,
                "id": 1483672085420708
            }
        ],
        "properties": {
            "moduleHeight": 180,
            "width": 750,
            "isModuleMargin": "1",
            "height": 360
        }
    }

    说明:

    • 单图模块中,只限制了图片的宽度,不限制高度。

    • widthheight分别是图片的原始尺寸,单位是px.

  5. 双图模块 -- DoubleImage

    示例数据:

    {
        "data": [
            {
                "resource": "http://m.yohobuy.com/1",
                "__index": 0,
                "linkType": "2",
                "text": "",
                "pic": "http://img12.static.yhbimg.com/yhb-img02/2017/01/06/11/02b2675a95730726511e06a8ee4a2d95c5.png",
                "_num": 0,
                "id": 1483672130640415
            },
            {
                "resource": "51147801",
                "__index": 1,
                "linkType": "1",
                "text": "",
                "pic": "http://img10.static.yhbimg.com/goodsimg/2015/09/15/13/0193a54b330f0bc8a932a2898c44b786d2.jpg?imageView2/1/w/375/h/375",
                "_num": 1,
                "id": 1483672130640605
            }
        ],
        "properties": {
            "isModuleMargin": "1"
        }
    }
  6. 三图模块 -- TripleImage

    示例数据:

    {
        "data": [
            {
                "resource": "272",
                "__index": 0,
                "linkType": "0",
                "text": "",
                "pic": "http://img12.static.yhbimg.com/yhb-img02/2017/01/11/12/02b5e801801a4a691c079db8d2689fa35d.png",
                "_num": 0,
                "id": 1484109197081597
            },
            {
                "resource": "51147732",
                "__index": 1,
                "linkType": "1",
                "text": "",
                "pic": "http://img13.static.yhbimg.com/goodsimg/2015/09/15/11/02a71305e488121e6bd26ce5d99b023dfd.jpg?imageView2/1/w/250/h/330",
                "_num": 1,
                "id": 1484109197081325
            },
            {
                "resource": "http://m.yohobuy.com",
                "__index": 2,
                "linkType": "2",
                "text": "",
                "pic": "http://img13.static.yhbimg.com/yhb-img02/2017/01/11/12/02d21372e7def8335b8e70450032a8d8e3.png",
                "_num": 2,
                "id": 1484109197081945
            }
        ],
        "properties": {
            "displayType": "1",
            "isModuleMargin": "1"
        }
    }

    三图模块的展示方式分为四种,通过displayType来控制,说明如下:

    displayType 说明
    1 三张图尺寸均为250*330,单位px,三张图并列展示
    2 三张图尺寸均为250*250,单位px,三张图并列展示
    3 前两张尺寸为375*234,第三张尺寸为375*468,单位px,展示方式是左2右1
    4 第一张尺寸为375*468,后两张尺寸为375*234,单位px,展示方式是左1右2
  7. 视频模块 -- Video

    示例数据:

    {
        "data": [
            {
                "__index": 0,
                "text": {
                    "title": "直播测试",
                    "content": "这是一条测试的直播内容~~~~"
                },
                "pic": "http://img12.static.yhbimg.com/yhb-img02/2017/01/06/11/02afefac902dbc25613b82ebf175082a07.png",
                "video": "http://a.b.c",
                "_num": 0,
                "id": 1483672510741937
            }
        ],
        "properties": {
            "isModuleMargin": "1"
        }
    }

    说明:

    直播中的text是个对象,包含了title---直播介绍标题content---直播介绍内容

  8. SKN列表 -- SknList

    示例数据:

    {"data":["51147735","51147734","51147801","51147732","51147733"]}

    说明: 该模块是方便前台查询,并不属于装修展示内容!!!