BOSS 系统 二期API

[TOC]

1 返回码

除统一登录返回码外，见： http://arch.smartmideazy.com/docs/account/account-doc.html

以下是BOSS系统网关的返回码，如下：

2 登录接口及域名

注：登录接口使用的是统一登录的域名。

参见：

http://arch.smartmideazy.com/docs/account/account-doc.html

统一登录域名

统一登录返回数据约定：

{"code":"200","data":{"tokenInfo":{"name":"睿住IOT超级管理员","orgFullName":null,"id":"356","orgId":null,"org_code":null,"user_name":"superadm","position":"超级管理员","mobile":"13926003676","nick_name":"客户000008","is_supper":2,"status":1,"bizOrgId":null,"bizOrgCode":null,"bizOrgFullName":null,"ico":null,"active_days":786,"login_times":44,"credentials":"U2FsdGVkX1%2FT8U2vt85LOxdhIiBRtezkrxE5kWoQOb8UD4NsJ1AGcpQ3s%2BOKxYZi","roles":null,"orgRoles":null,"tenantId":null,"top_org_code":null,"top_org_id":null,"encryptKey":"I2hMACsAfE5FHL0gB2ireJAOjh7mN4MX8yTgCrnTqUCkNLYiWaMIIokoyBbAfTrq68iEN0jNSCX0ssg9WwQ%2BNzLXJf6fh13Ay638xYWhNhVxKE83tzCU6AB4NFWTR6ILIyuhGkauo%2BHWUPn%2Fqoryz7qbibslCAJht5etTgYTtWfeM%2BH9t3auAjgkqbdViidF8SuTnsgd7y%2F62bhxOAi%2Bwlp%2BJqSY9VZGrvR%2FVd4vNj%2Fd6rZ8ectnXkEK2NIBBrzQY42bNRk9%2B4kfJOa%2FpCJLTXJQoX9zpImVsmr1roEwpGWvAD6Dj606NbuknkIl%2BJJsrFjbQKdqgaqvSBqEjyMh3A%3D%3D"},"token":{"access_token":"eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJwbGF0Zm9ybV90aWNrZXQiLCJqdGkiOiJmZWFjZmE3Mi0wZDQ3LTRjZjYtYjBhMC0zMWE4YjE0MmU4MWYiLCJ1c2VyX2lkIjozNTYsImxvZ2luX3RpbWVzIjoiNDMiLCJzcmMiOjEsInVzZXJfbmFtZSI6InN1cGVyYWRtIiwicm9sZXMiOlsiU1lTX0FETUlOIl0sIm5hbWUiOiLnnb_kvY9JT1TotoXnuqfnrqHnkIblkZgiLCJpZCI6MzU2LCJjbGllbnRfaWQiOiJib3NzLWNsaWVudCIsImFjdGl2ZV9kYXlzIjoiNzg2IiwiaXNfc3VwcGVyIjoyLCJpc3MiOiJyZW1hYyIsImlhdCI6MTY3OTk3NzgxMiwiZXhwIjoxNjgwMzkyNTMyfQ.CP85pCZhLh1w8rPn3Eh7lUObWpsfbNPrjfLeRmX4mckneIU3almYGZiAOh9sN09FgP7QJVcQQffpuUNp234gfWJdoSXu5cFDm70woB3vJywgXvwi_FmdzipVOkuGhY_OYfBfa2LH4NwETIDoSuiBHJwp-5OtpD0xOWNYeF6QCLH46KRevRE1B9vdwoXrHczgQ4ZKLHvJ4sWQ90Us3mBU1Hja1kDbYbrSJipmptPryBN5C1I1nX2OUFSOaDuzdSxqfu43xUGcnrNkt_M2pBHQio5dH4BZxu9do2VNTKKg6NTVRee-QU0ZpXXo6_Sq2fbD5FaGh-qFejfDPJVteax8wQ","token_type":"bearer","refresh_token":"eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJwbGF0Zm9ybV90aWNrZXQiLCJqdGkiOiJmZWFjZmE3Mi0wZDQ3LTRjZjYtYjBhMC0zMWE4YjE0MmU4MWYiLCJ1c2VyX2lkIjozNTYsImxvZ2luX3RpbWVzIjoiNDMiLCJzcmMiOjEsInVzZXJfbmFtZSI6InN1cGVyYWRtIiwicm9sZXMiOlsiU1lTX0FETUlOIl0sImF0aSI6ImZlYWNmYTcyLTBkNDctNGNmNi1iMGEwLTMxYThiMTQyZTgxZiIsIm5hbWUiOiLnnb_kvY9JT1TotoXnuqfnrqHnkIblkZgiLCJpZCI6MzU2LCJjbGllbnRfaWQiOiJib3NzLWNsaWVudCIsImFjdGl2ZV9kYXlzIjoiNzg2IiwiaXNfc3VwcGVyIjoyLCJpc3MiOiJyZW1hYyIsImlhdCI6MTY3OTk3NzgxMiwiZXhwIjoxNjg0MTI1MDEyfQ.qS9IEyvs0SUonXbgvd4_YKIVmaGjausFvNfNK44abJCjSzh-uZ9GkbPonzhIxYkbHHhQroEcSHJ7C3xzYwUwfGBeumR5zJTkx8yDGuB_krd93ntZWNJb6PZwKhmRCMPfYLBZoa8f0rwh830wv8UdQ9fPo5EQMfAmt4U5C8ARjanYgWTXAAbxxDDEW6Ku0RnLbSDoU_VbCfUbZfecxDQH6vl7XO6aZsCvrKYh0ZtCdlphzpGa55wPTQnOMNRXy21uhTCDhn5lNPfLpWjXEHXn1A_9cpiPdsNNB2FIothmPJeVTmtIGr4Zv0nHb2vzG9pn7_oBD3pLBWfoWfc6U1jIRA","scope":"all","jti":"feacfa72-0d47-4cf6-b0a0-31a8b142e81f","expires_in":414720,"roles":["SYS_ADMIN"],"top_org_id":null,"top_org_code":null,"isSys":null,"tenantName":null}},"message":"success"}

请各端本地保存好 access_token和 refresh_token。 一般access_token 2小时过期， refresh_token较 access_token过期时间更长， 在access_token过期后，请使用 refresh_token刷新token，替换旧的 access_token和 refresh_token。

3 本期BOSS系统API域名

本期所有的API需要经过天选商城网关，且遵循《4 安全规范》。 请注意：由于BOSS二期用到天选的接口，故一期与二期的域名是不同的， BOSS一期的域名请参见： 《http://arch.smartmideazy.com/docs/boss/boss.html》。

4 安全规范及全局字典

4.1 安全规范

除白名单接口外，所有的API接口HTTP头部必须带remacToken 作为HTTP头部标识。

注：remacToken 即 《2 登录接口及域名》中登录返回的access_token。

4.1.1 h5 配置 client_id

超管登录后，跳转至BOSS 系统的WEB 页面。 需要在中台为BOSS 系统的WEB 工程配置client_id和client_secret、access_token/refresh_token过期时间。

测试环境：

4.2 全局字典

4.2.1 门店类型

4.2.2 中台全局支付信息

指支付主体的对公帐号、开票税号、SRM帐套编码、SRM成本中心部门编码、ERP部门编码、ERP业务实体编码等全局信息。其结果整合在一个接口中，以方便业务方使用。

中台全局支付信息对象属性如下：（后期将有更多更新）

5 接口列表

5.1 创建/更新企业信息

企业信息更新，包括启用/禁用等。

请求信息

HTTP协议：HTTP,HTTPS

URL: /tx/platform-biz/remac-tx-account/company/submit

HTTP头： remacToken

方法：POST

请求参数 (body):

返回

{

   code:'200',
   message:'success',
   data: {

      公司对象
   }
}

5.2 加载企业信息

查询企业信息详情。

请求信息

HTTP协议：HTTP,HTTPS

URL: /tx/platform-biz/remac-tx-account/company/detail/{id}

方法：GET

HTTP头： remacToken

参数： id

返回：

{

   code:'200',
   message:'success',
   data: {

      公司对象
   }
}

5.3 删除企业

删除企业。

请求信息

HTTP协议：HTTP,HTTPS

URL: /tx/platform-biz/remac-tx-account/company/remove

方法：POST

HTTP头： remacToken

参数：

返回：

{

   code:'200',
   message:'success',
   data: {

      是否删除成功布尔值
   }
}

5.4 企业列表分页

企业列表分页。

请求信息

HTTP协议：HTTP,HTTPS

URL: /tx/platform-biz/remac-tx-account/company/list

HTTP头： remacToken

方法：GET

请求参数:

返回

{

   code:'200',
   message:'success',
   data: {

      分页列表
   }
}

5.5 创建/更新门店信息及门店超管帐号

说明：此接口新增/修改门店及超管帐号信息。

请求信息

HTTP协议：HTTP,HTTPS

URL: /tx/platform-biz/remac-tx-account/shop/submit

HTTP头： remacToken

方法：POST

请求参数 (body):

返回

{

   code:'200',
   message:'success',
   data: {

       店铺对象
   }
}

5.6 店铺列表分页

店铺列表分页。

请求信息

HTTP协议：HTTP,HTTPS

URL: /tx/platform-biz/remac-tx-account/shop/list

HTTP头： remacToken

方法：GET

请求参数:

返回

{

   code:'200',
   message:'success',
   data: {

      分页列表
   }
}

5.7 加载店铺信息

请求信息

HTTP协议：HTTP,HTTPS

URL: /tx/platform-biz/remac-tx-account/shop/detail/{id}

HTTP头： remacToken

方法：POST

请求参数 id: 门店主键ID

返回

{

   code:'200',
   message:'success',
   data: {

        店铺对象
   }
}

5.7A 一次性查询多个店铺信息

请求信息

HTTP协议：HTTP,HTTPS

URL: /tx/platform-biz/remac-tx-account/shops/byshopids

HTTP头： remacToken

方法：POST

返回

{

   code:'200',
   message:'success',
   data: [

        {店铺对象}, ...{店铺对象}
   ]
}

5.8 删除店铺

删除店铺。

请求信息

HTTP协议：HTTP,HTTPS

URL: /tx/platform-biz/remac-tx-account/shop/remove

方法：POST

HTTP头： remacToken

参数：

返回：

{

   code:'200',
   message:'success',
   data: {

      是否删除成功布尔值
   }
}

5.9 根据店铺标识查询店铺详情与所属企业

根据店铺标识查询店铺详情与所属企业。

请求信息

HTTP协议：HTTP,HTTPS

URL: /tx/platform-biz/remac-tx-account/shop/loadDataByShopId/{shopId}

方法：GET

HTTP头： remacToken

参数：

返回：

{
    "code": "200",
    "message": "请求成功",
    "data": {
        "shop": {
            "id": "75",
            "shopName": "睿住装饰-北滘分店",
            "shopAddress": "广东省佛山市顺德区美的悦然广场188号",
            "provinceCode": "440000",
            "cityCode": "440600",
            "districtCode": "440606",
            "provinceName": "广东省",
            "cityName": "佛山市",
            "districtName": "顺德区",
            "addressStreet": "美的悦然广场188号",
            "companyId": "63",
            "businessCert": "https://remac-tx.oss-cn-hangzhou.aliyuncs.com/null/20230509151528285904134.png",
            "createTime": "2023-05-09 15:15:39",
            "createBy": "功夫熊猫",
            "shopEnabled": 1,
            "position_3d": null,
            "grantResources": "1,3",
            "serviceAbility": 2,
            "serviceEngineers": "[]",
            "shopBrief": null,
            "adminAccount": "15625059654",
            "shopDescription": "北滘分店承接全国各地装修装饰设计业务。",
            "updateTime": null,
            "updateBy": null
        },
        "company": {
            "id": "63",
            "companyName": "睿住装饰设计公司",
            "companyAddress": "广东省佛山市顺德区北滘镇美的置业广场188号",
            "provinceCode": "440000",
            "cityCode": "440600",
            "districtCode": "440606",
            "provinceName": "广东省",
            "cityName": "佛山市",
            "districtName": "顺德区",
            "addressStreet": "北滘镇美的置业广场188号",
            "contactName": "叶桂芳",
            "contactMobile": "15625059654",
            "shopCount": 2,
            "companyLogo": "https://remac-tx.oss-cn-hangzhou.aliyuncs.com/null/202305091510431383048703.jpg",
            "companyEnabled": 1,
            "createTime": "2023-05-09 15:11:29",
            "updateBy": "功夫熊猫",
            "updateTime": "2023-05-09 15:21:53",
            "createName": "功夫熊猫",
            "companyDescription": "广东睿住智能科技有限公司，成立于2015年，总部位于佛山，美的控股成员企业，是行业领先的空间智能解决方案商。睿住智能以用户真实需求为出发点，依托空间智能全栈技术体系，打造智慧家庭、智慧社区、智慧园区、智慧医养、智慧商业等多业态的空间智能解决方案，为客户提供“咨询、设计、交付、售后、运维”的全链条品质"
        }
    }
}

5.10 获取店铺列表

描述： 获取所有的门店数据

请求信息

HTTP协议：HTTP,HTTPS

URL: /tx/platform-biz/remac-tx-account/list

方法：GET

HTTP头： remacToken

返回：

{
  "code": "200",
  "data": [
     {
      "id": "144",
      "shopName": "nn小店A07",
      "shopAddress": "浙江省杭州市余杭区西湖路上绿柳丛",
      "provinceName": "浙江省",
      "cityName": "杭州市",
      "districtName": "余杭区",
      "addressStreet": "西湖路上绿柳丛"
      },.. { ... }
      ]

    },

6.0 门店超管帐号

6.0.1 门店管理员帐号（手机号）检验

说明：检查手机号是否可用。

请求信息

HTTP协议：HTTP,HTTPS

URL: /v1/iot/main/supper/boss/account/check

方法：POST

请求参数 (body):

返回code说明：

6.0.2 手机号作为帐号并初始化密码保存信息

说明：手机号作为帐号并初始化密码，密码以短信形式发送。BOSS系统创建门店超管帐号用。

考虑到此接口的潜在风险，在平台侧会校验此帐号是否为平台超管帐号，仅限BOSS系统创建门店超管帐号用。 其他业务系统调用将会出错。

请求信息

URL: /v1/iot/main/supper/boss/account/save

HTTP协议：HTTP,HTTPS

HTTP头： remacToken

方法：POST

说明：手机号作为帐号并初始化密码，密码以短信形式发送。

请求参数 (body):

已存在手机号作为帐号的用户将返回已有的帐号信息。或不存在则返回平台新建的用户信息。

{

   "code":"200",
   "message","succes", "data": {

      // 用户帐号信息 { id: XX , ....} 

   }
}

其中，id 为帐号的主键ID。

返回code说明：

6.0.2A 手机号作为帐号并初始化密码保存信息

说明：手机号作为帐号并初始化密码，密码以明文返回，业务系统将密码明文以短信发送。此接口仅限加盟商创建门店普通帐号用。请注意与5.5.2接口的区别。

请求信息

URL: /v1/iot/main/supper/boss/account/save2

HTTP协议：HTTP,HTTPS

HTTP头： remacToken

方法：POST

请求参数 (body):

已存在手机号作为帐号的用户将返回已有的帐号信息。或不存在则返回平台新建的用户信息。

{

   "code":"200",
   "message","succes", "data": {

      // 用户帐号信息 { id: XX , ....} 

   }
}

其中，id 为帐号的主键ID。

返回code说明：

6.1 创建/修改门店

建立一条新的帐号与门店的关联关系。也可以建立一条新帐号与门店关联关系的同时解除旧帐号与门店的关联。

注：考虑到数据的一致性和用户的体验，此接口在原有的接口的基础上新增oldAccountId字段（非必选），支持建立新帐号与门店关联的同时删除旧帐号与门店的关联，此场景应用于门店超管帐号的修改场景。

HTTP协议：HTTP,HTTPS

URL: /tx/platform-biz/remac-tx-account/accountshoprel/submit

HTTP头： remacToken

方法：POST

请求参数 (body):

6.2 帐号与门店解除关联

描述：解除多个帐号与当前门店的关联。 注： 门店超管帐号不可与门店解除关联。

HTTP协议：HTTP,HTTPS

URL: /tx/platform-biz/remac-tx-account/accountshoprel/unrel

HTTP头： remacToken

方法：POST

请求参数 (body):

5.8 根据一个帐号加载所有关联的门店

描述：由帐号ID加载出所关联的门店

HTTP协议：HTTP,HTTPS

URL: /tx/platform-biz/remac-tx-account/accountshoprel/getShops/{accountId}

HTTP头： remacToken

方法：GET

路径参数 accountId : 帐号ID(必传)

返回：

{
  "code": "200",
  "message":"success",
  "data": [ { 门店对象1 JSON   } ... { 门店对象2 JSON} ]


}

其中： status字段说明： 1 ：帐号启用 2: 帐号禁用

6.3 通过店铺标识查询帐号列表

通过店铺标识查询帐号列表。

请求信息

HTTP协议：HTTP,HTTPS

URL: /tx/platform-biz/remac-tx-account/accountshoprel/getAccountByShop

方法：GET

HTTP头： remacToken

参数：

返回：

{
    "code": "200",
    "message": "请求成功",
    "data": [
        {
            "id": "42",
            "shopId": "75",
            "accountId": "134681",
            "mainFlag": 2,
            "createTime": "2023-05-11 16:48:56",
            "updateTime": "2023-05-11 16:48:56",
            "createBy": "功夫熊猫",
            "updateBy": "功夫熊猫",
            "mobile": null,
            "roleFlag": 1,
            "status": 1
        },
        {
            "id": "43",
            "shopId": "75",
            "accountId": "134707",
            "mainFlag": 2,
            "createTime": "2023-05-11 09:27:20",
            "updateTime": null,
            "createBy": null,
            "updateBy": null,
            "mobile": null,
            "roleFlag": 1,
            "status": 1
        },
        {
            "id": "41",
            "shopId": "75",
            "accountId": "261274",
            "mainFlag": 1,
            "createTime": "2023-05-09 15:15:39",
            "updateTime": null,
            "createBy": "功夫熊猫",
            "updateBy": null,
            "mobile": "15625059654",
            "roleFlag": 0,
            "status": 1
        }
    ]
}

6.4 由手机号查询平台所有绑定的帐号信息

描述： 一个手机号可以关联多个帐号。

HTTP协议：HTTP,HTTPS

URL: /v1/iot/main/supper/boss/account/list/get/{mobile}/{src}

HTTP头： remacToken

方法：GET

路径参数 mobile : 手机号(必传)

​ src : 帐号来源（1：社区帐号 4: 家庭帐号。)

返回：

{
  "code": "200",
  "message":"success",
  "data": [ { 帐号对象1 JSON   } ... { 帐号对象2 JSON} ]


}

6.5文件上传

本期企业及门店LOGO上传均使用此接口

描述：

上传单个文件

HTTP协议：

HTTP,HTTPS

URL:

/tx/platform-biz/remac-tx-file/file/uploadFile

HTTP头：

remacToken/iotaccounttoken

方法：

POST

路径参数：

返回：

{
  "code": "200",
  "message":"success",
  "data": 下载/预览链接url
}

6.6 由员工ID集合查询员工帐号列表（分页）

说明：

请求信息

URL: /v1/iot/main/supper/boss/account/accounts/page

HTTP协议：HTTP,HTTPS

HTTP头： remacToken

方法：POST

请求参数 (body):

6.6A 由关键词查询员工帐号列表（分页）

说明：此接口需要考虑到多租户数据隔离的场景。如： A公司不可查询B公司加盟商门店的数据。

由当前门店查询到门店所属的公司，再查询公司下的所有的门店，找出门店所关联的所有的帐号，在这个帐号范围下查询帐号列表。 如果帐号开启了分享，也可以被其他公司门店的设计师查询出来。

关键词范围： 员工姓名、手机号。

请求信息

URL: /tx/platform-biz/remac-tx-account/accounts/page/bykeyword

HTTP协议：HTTP,HTTPS

HTTP头： remacToken

方法：POST

请求参数 (body):

6.6B 由加盟商门店ID集合查询其公司下所有的门店列表

说明：先由门店集合查询公司列表，再由公司列表查询所有的门店集合。

请求信息

URL: /tx/platform-biz/remac-tx-account/shops/byshopids

HTTP协议：HTTP,HTTPS

HTTP头： remacToken

方法：POST

请求参数 (body):

6.6C 由门店ID集合门店列表

说明：与接口 /tx/platform-biz/remac-tx-account/shops/byshopids不同， 此接口没有做到数据隔离，仅用于特殊场景。请业务侧做好不同公司间的数据隔离。

请求信息

URL: /tx/platform-biz/remac-tx-account/shops/shopids

HTTP协议：HTTP,HTTPS

HTTP头： remacToken

方法：POST

请求参数 (body):

6.7帐号启用/禁用

描述： 仅对门店级帐号作启用/禁用。

当帐号在所有的门店都处于禁用状态时，帐号不可登录。

当帐号在一个以上的门店处于启用时，帐号可登录。

URL: /tx/platform-biz/remac-tx-account/account/status/set

HTTP协议：HTTP,HTTPS

HTTP头： remacToken

方法：PUT

请求参数 (body):

6.8 门店类型查询

描述： 从中台全局字典中查询门店类型。

URL: /tx/platform-biz/remac-tx-public/config/list?bizType=XX

HTTP协议：HTTP,HTTPS

HTTP头： bizToken/remacToken

方法：GET

请求参数(非body)

返回示例：

{
  "code": "200",
  "data": [
    {
      "enumKey": "ZYD",
      "enumValue": "自营店"
    },
    {
      "enumKey": "QJD",
      "enumValue": "旗舰店"
    },
    {
      "enumKey": "ZXD",
      "enumValue": "智选店"
    },
    {
      "enumKey": "LMD",
      "enumValue": "联名店"
    },
    {
      "enumKey": "LD",
      "enumValue": "联营店"
    },
    {
      "enumKey": "QZYXD",
      "enumValue": "前置营销店"
    },
    {
      "enumKey": "VIP",
      "enumValue": "VIP门店"
    }
  ],
  "message": "success"
}

6.9 查询中台全局支付实体列表

描述：查询中台全局支付实体列表， 不分页。 在加盟端门店的创建和修改接口中需要指定一个全局支付实体，具体参见数据字典 《4.2.2 全局支付信息》。

URL: /tx/platform-biz/remac-pay-mid/payinfo/list/${business_type}

HTTP协议：HTTP,HTTPS

HTTP头： bizToken

方法：GET

路径参数(非body)

返回示例：

{
  "code": "200",
  "data": [
    {
      "account_number": "44050166733600002087",
      "ou_code": "DDD",
      "seller_tax_no": "DD",
      "cost_center": "DDDDDDD",
      "pay_company_name": "广东睿住智能科技有限公司",
      "org_id": "dddddd",
      "business_type": "tiance",
      "account_name": "广东睿住智能科技有限公司",
      "dept_code": "Ddddddd",
      "pay_company_id": 200030,
      "account_bank": "中国建设银行股份有限公司顺德北滘支行",
      "business_id": "1101"
    }
  ],
  "message": "success"
}

6.10 由中台虚拟支付实体标识查询中台全局支付信息

描述：依据家盟商门店归属中台虚拟支付实体标识查询中台全局支付信息， 见《4.2.2 全局支付信息》。

精确返回一条记录。

URL: /tx/platform-biz/remac-pay-mid/payinfo/detail/query

HTTP协议：HTTP,HTTPS

HTTP头： bizToken

方法：PUT

请求参数(body)

说明： pay_company_id 与 business_id、business_type 不可两者均为空，两者任选其一。如：pay_company_id 有值，business_id、business_type可以为空；

business_id、business_type有值，pay_company_id 可以为空。

三个参数据均有值，将取pay_company_id 进行查询。

返回示例：

{
  "code": "200",
  "data": {全局支付信息},
  "message": "success"
}

其中“全局支付信息”各字段请参见数据字典 《.2.2 中台全局支付信息》。

6.11 门店启用/禁用

描述： 业务中台仅对门店作启用/禁用。

URL: /tx/platform-biz/remac-tx-account/accountshoprel/shop/status/set

HTTP协议：HTTP,HTTPS

HTTP头： remacToken

方法：PUT

请求参数 (body):