edit

产品查询

查询产品及目录

普通用户调用该接口将返回企业所有产品的配置,分目录返回。

GET https://console-openapi.hekr.me/api/v1/product?releaseOnly=true HTTP/1.1
Accept-Language: zh-CN
Authorization: Bearer {{JWT_TOKEN}}
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

[
  {
    "category": {
      "id": "a49fb62ce330",
      "name": {
        "zh_CN": "灭蚊器",
        "en_US": "Mosquito Killer"
      },
      "logo": "https://stage-allinone-ufile.hekr.me/category/baab76be-1a8a-45e2-9845-1d28e9d6591e/icon_49@3x.png",
      "parent": {
        "id": "56efcab1a8ee",
        "name": {
            "zh_CN": "生活电器",
            "en_US": "Life electric application"
        }
      }
    },
    "products": [
        {
          "mid": "Dn4D4LnMgU7m",
          "name": "English Product Name",
          "productType": "INDEPENDENT",
          "displayName": {
            "zh_CN": "中文产品名称",
            "en_US": "English Product Name"
          },
          "model": "m1",
          "logo": "https://stage-allinone-ufile.hekr.me/category/baab76be-1a8a-45e2-9845-1d28e9d6591e/icon_49@3x.png",
          "status": "RELEASE_PASS",
          "bindType": "WIFI",
          "accessWay": [
              "WIFI"
          ],
          "configDesc": "fasdf",
          "configDescImg":[
              "https://stage-allinone-ufile.hekr.me/category/baab76be-1a8a-45e2-9845-1d28e9d6591e/icon_49@3x.png"
          ]
        }
    ]
  }
]

请求参数

参数 是否必选 默认 含义
releaseOnly true 当为true时只显示已发布产品,当为false时显示所有产品
configType 以配网方式过滤设备,例如 HekrConfig, AirKiss(用于微信)

请求头

参数 是否必选 默认 含义
Accept-Language 用户语言Language-Tag,当前支持zh-CN, en-US

返回体

字段 含义
products.name 产品名称,多语言配置时会返回对应Accept-Language的配置
products.configDescImg 配网指导图片(优先于配网文字描述展示)
products.logo 产品LOGO
products.configDesc 配网文字描述

查询产品列表

普通用户调用该接口将返回企业所有产品的配置,分目录返回。

GET https://console-openapi.hekr.me/api/v1/product?flat=true&releaseOnly=true HTTP/1.1
Accept-Language: zh-CN
Authorization: Bearer {{JWT_TOKEN}}
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

[
    {
        "mid": "P9KAuCJc6E8N",
        "name": "English name",
        "productType": "INDEPENDENT",
        "displayName": {
            "zh_CN": "中文名称",
            "en_US": "English name"
        },
        "model": "m1",
        "logo": "https://stage-allinone-ufile.hekr.me/category/baab76be-1a8a-45e2-9845-1d28e9d6591e/icon_49@3x.png",
        "status": "NEW",
        "bindType": "OTHER",
        "accessWay": [
            "WIFI"
        ],
        "configDesc": "重复按开关5次后指示灯灯转为绿色后,设备进入配网状态。",
        "airKissConfig": {
            "wechatProductId": "27108",
            "wechatQRCode": "https://shp.qpic.cn/hd_priv_pic/0/15106820907e4de5d19074fcd824772a43497cca37/0"
        },
        "configDescImg": [
            "https://stage-allinone-ufile.hekr.me/product-config/56524b7f-1d0a-45e6-b3f2-703a0c069e5f.jpg"
        ],
        "attributes": {}
    }
]

请求参数

参数 是否必选 默认 含义
releaseOnly true 当为true时只显示已发布产品,当为false时显示所有产品
configType 以配网方式过滤设备,例如 HekrConfig, AirKiss(用于微信)
flat 当flat为true时不分目录,直接返回产品列表

请求头

参数 是否必选 默认 含义
Accept-Language 用户语言Language-Tag,当前支持zh-CN, en-US

返回体

查询产品及目录返回体相同

字段 含义
name 产品名称,多语言配置时会返回对应Accept-Language的配置
configDescImg 配网指导图片(优先于配网文字描述展示)
logo 产品LOGO
configDesc 配网文字描述
airKissConfig.wechatProductId 微信产品ID
airKissConfig.wechatQRCode 微信二维码