Yoho-Documents / API-Interfaces · Files

Go to a project
线下店.md 9.16 KB

1、根据屏幕code获取节目单信息

请求参数

参数名称 参数类型 可否为空 示例 默认值 备注
screenCode String 否 2 null 域名

注意，通用的头部没有列出。
请求示例 http://172.16.6.125:8080/shops/ProgramController/getProgramInfoByScreenCode.do?screenCode=2

响应

code为200即为成功，否则是失败。

其中data为返回的内容，program为节目单信息：1代表单屏节目单,2代表组合屏节目单,3代表全场屏节目单，4代表紧急屏节目单，version为版本号

节目单列表的字段如下：

id：节目单信息id

programId：节目单id

listName：节目名称

startTime：播放开始时间

endTime：播放结束时间

isLoop：是否循环（1循环0不循环）

playType：播放类型（1文字2图片3视频）

playContent：播放内容

effect为动效对象，其中id是动效id，effectName是动效名称，effectFiles是动效播放文件，多个动效文件以,分隔

offTime：熄屏时间

响应JSON格式如下所示:

{
    "code": 200,
    "message": "success",
    "data": {
        "program": {
            "1": [
                {
                    "id": 2,
                    "programId": 18,
                    "listName": "单屏节目一",
                    "startTime": "9:00",
                    "endTime": "12:00",
                    "isLoop": 1,
                    "playType": 1,
                    "playContent": "it.nov",
                    "effect": {
                        "id": 2,
                        "effectName": "特效1",
                        "effectFiles": "http://img10.static.yhbimg.com//2016/06/29/11/016eb4c1fdb8a22b15d1e69ed998a77cc1.jpg,http://img11.static.yhbimg.com//2016/06/29/10/012847d93ea0d875de8c03dc9bfb67fc9b.jpg"
                    },
                    "offTime": 30
                }
            ],
            "2": [
                {
                    "id": 4,
                    "programId": 20,
                    "listName": "组合节目一",
                    "startTime": "13:00",
                    "endTime": "14:00",
                    "isLoop": 1,
                    "playType": 1,
                    "playContent": "it.nov",
                    "effect": {
                        "id": 2,
                        "effectName": "特效1",
                        "effectFiles": "http://img10.static.yhbimg.com//2016/06/29/11/016eb4c1fdb8a22b15d1e69ed998a77cc1.jpg,http://img11.static.yhbimg.com//2016/06/29/10/012847d93ea0d875de8c03dc9bfb67fc9b.jpg"
                    },
                    "offTime": 30
                }
            ],
            "3": [
                {
                    "id": 6,
                    "programId": 22,
                    "listName": "全场节目一",
                    "startTime": "10:00",
                    "endTime": "12:00",
                    "isLoop": 1,
                    "playType": 1,
                    "playContent": "it.nov",
                    "effect": {
                        "id": 2,
                        "effectName": "特效1",
                        "effectFiles": "http://img10.static.yhbimg.com//2016/06/29/11/016eb4c1fdb8a22b15d1e69ed998a77cc1.jpg,http://img11.static.yhbimg.com//2016/06/29/10/012847d93ea0d875de8c03dc9bfb67fc9b.jpg"
                    },
                    "offTime": 30
                },
                {
                    "id": 8,
                    "programId": 22,
                    "listName": "全场节目一",
                    "startTime": "14:00",
                    "endTime": "18:00",
                    "isLoop": 1,
                    "playType": 1,
                    "playContent": "it.nov",
                    "effect": {
                        "id": 2,
                        "effectName": "特效1",
                        "effectFiles": "http://img10.static.yhbimg.com//2016/06/29/11/016eb4c1fdb8a22b15d1e69ed998a77cc1.jpg,http://img11.static.yhbimg.com//2016/06/29/10/012847d93ea0d875de8c03dc9bfb67fc9b.jpg"
                    },
                    "offTime": 30
                }
            ],
            "4": [
                {
                    "id": 10,
                    "programId": 23,
                    "listName": "紧急节目一",
                    "startTime": "10:00",
                    "endTime": "12:00",
                    "isLoop": 1,
                    "playType": 1,
                    "playContent": "it.nov",
                    "effect": {
                        "id": 2,
                        "effectName": "特效1",
                        "effectFiles": "http://img10.static.yhbimg.com//2016/06/29/11/016eb4c1fdb8a22b15d1e69ed998a77cc1.jpg,http://img11.static.yhbimg.com//2016/06/29/10/012847d93ea0d875de8c03dc9bfb67fc9b.jpg"
                    },
                    "offTime": 0
                }
            ]
        },
        "version": 0
    }
}

2、线下店店员登录接口

请求参数

参数名称 参数类型 可否为空 示例 默认值 备注
method String 否 app.shops.loginApp null
loginName String 否 test null
loginPwd String 否 123456 null

注意，通用的头部没有列出。
请求示例 http://172.16.6.219:8080/gateway?method=app.shops.loginApp&loginName=test&loginPwd=123456&debug=XYZ

响应

code为200即为成功，否则是失败。

其中data为返回的内容

节目单列表的字段如下：

userId：用户id

userName：用户名

storeId：门店id

storeName：门店名称

photo：员工头像

uid：对应前台用户id

响应JSON格式如下所示:

{
  "alg": "SALT_MD5",
  "code": 200,
  "data": {
    "uid": 0,
    "photo": "http://img10.static.yhbimg.com//2016/06/29/11/016eb4c1fdb8a22b15d1e69ed998a77cc1.jpg",
    "storeName": "StoreName",
    "userName": "测试用户",
    "storeId": 0,
    "userId": 18
  },
  "md5": "9721ddd72d417ccee4a3ebb7016e15d9",
  "message": "success"
}

3、线下店结算用户登录接口

请求参数

参数名称 参数类型 可否为空 示例 默认值 备注
method String 否 app.shops.loginPad null
profile String 否 13811111111 null 输入账号

注意，通用的头部没有列出。
请求示例 http://172.16.6.219:8080/gateway?method=app.shops.loginPad&profile=13811111111&debug=XYZ

响应

code为200即为成功，否则是失败。

其中data为返回的内容

节目单列表的字段如下：

newUser：是否是新用户

uid：对应前台用户id

响应JSON格式如下所示:

{
  "alg": "SALT_MD5",
  "code": 200,
  "data": {
    "uid": 20000898,
    "newUser": false
  },
  "message": "登录成功"
}

4、根据屏幕mac地址获取屏幕信息

请求参数

参数名称 参数类型 可否为空 示例 默认值 备注
mac String 否 2 ffffffff-ddfb-c673-ffff-ffffe7e0b841 mac地址

注意，通用的头部没有列出。
请求示例 http://192.168.102.210:8080/portal-gateway/ProgramInfoController/getScreenInfoByMac?debug=XYZ&mac=ffffffff-ddfb-c673-ffff-ffffe7e0b841

响应

code为200即为成功，否则是失败。

节目单列表的字段如下：

screenStatus : 屏幕状态(1-点亮；2-熄灭；3-损坏)

响应JSON格式如下所示:

{
  "code": 200,
  "message": "success",
  "data": {
    "createUserId": 454,
    "createUserName": null,
    "createTime": 1475979315,
    "createTimeStr": null,
    "status": 1,
    "statusStr": null,
    "updateTime": 1475979315,
    "updateTimeStr": null,
    "id": 1294,
    "screenName": "演示信息屏A",
    "screenType": 1,
    "screenStatus": 1,
    "goodsShelvesId": 14,
    "resolvingPower": "1366*768",
    "size": "55*55",
    "serialNumber": "",
    "mac": "ffffffff-ddfb-c673-ffff-ffffe7e0b841",
    "regionId": 2,
    "screenCode": "66-B1-100-B1-02-P-1294",
    "floorNum": 0,
    "screenNameAndCode": null,
    "screenTypeStr": null,
    "regionCode": null,
    "goodsShelvesCode": null,
    "screenStatusStr": null,
    "screenFloorAndRegion": null,
    "macAndSerialNumber": null,
    "screenSizeAndResolvingPower": null
  }
}

5、获取商品二维码url

请求参数

参数名称 参数类型 可否为空 示例 默认值 备注

注意，通用的头部没有列出。
请求示例 http://192.168.102.210:8080/portal-gateway/QRCodeURLController/getQRCodeURL?debug=XYZ

获取成功之后，要根据类型拼接参数：

根据类型替换参数

sku：{"product_sku":630988，"storeId":66}

skn：{"product_skn":51078948,"mac":"abcabc"}

完整的url示例：

sku请求：

http://192.168.102.210:8080/portal-gateway/html/qrcodeURL.html?yohobuy={"action":"go.productDetail","params":{"product_sku":630988,"storeId":66}}

响应

code为200即为成功，否则是失败。

响应JSON格式如下所示:

{
  "code": 200,
  "message": "success",
  "data": "http://192.168.102.210:8080/portal-gateway/html/qrcodeURL.html?yohobuy={"action":"go.productDetail","params":{params}}"
}