菜谱相关接口

本文介绍菜谱相关接口。使用菜谱相关接口前，需要将产品接入开发后台。接口请求方法请使用 TYSdk.native.apiRequest。

菜谱列表数据获取（接入多语言区分）

API 名称

tuya.ia.content.lang.onlinelist

API 版本

1.0

参数

名称	类型	描述	是否必选
productId	String	产品 ID	是
contentType	String	查询类型，默认为 cookbook	是
lang	String	多语言标识符，中文为 zh-CN	是
pageNo	Integer	分页标示	是
pageSize	Integer	分页步长	是
categoryName	String	菜谱品类名	否
nameSearch	String	搜索名称	否

请求示例

{
  "productId": "",
  "contentType": "cookbook",
  "lang": "zh-CN",
  "pageNo": 1,
  "pageSize": 2000,
  "categoryName": ""
}

返回示例

{
  "result" : {
    "contentList": []
  },
  "t" : 1527771204905,
  "success" : true,
  "status" : "ok"
}

菜谱列表数据获取（不接入多语言区分）

API 名称

tuya.ia.content.onlinelist

说明： 仅支持中文数据。

API 版本

1.0

参数

名称	类型	描述	是否必选
productId	String	产品 ID	是
contentType	String	查询类型，默认为 cookbook	是
nameSearch	String	菜谱名称	否
pageNo	Integer	分页标示	是
pageSize	Integer	分页步长	是
categoryName	String	菜谱品类名	否

请求示例

{
  "productId": "",
  "contentType": "cookbook",
  "pageNo": 1,
  "pageSize": 2000,
  "categoryName": ""
}

返回示例

{
  "result" : {
    "contentList": []
  },
  "t" : 1527771204905,
  "success" : true,
  "status" : "ok"
}

获取单个菜谱的详情数据

API 名称

tuya.ia.content.lang.detail

API 版本

1.0

参数

名称	类型	描述	是否必选
productId	String	产品 ID	是
contentId	String	菜谱 ID	是
lang	String	多语言标识符，中文为 zh-CN	是

请求示例

{
  "productId":  "",
  "contentId": "",
  "lang": "zh-CN"
}

返回示例

{
  "result" : {
    "contentList": []
  },
  "t" : 1527771204905,
  "success" : true,
  "status" : "ok"
}

获取符合筛选条件的菜谱

API 名称

tuya.ia.content.lang.query

API 版本

1.0

参数

名称	类型	描述	是否必选
productId	String	产品 ID	是
lang	String	多语言标识符，中文为zh-CN	是
pageNo	Integer	分页标示	是
pageSize	Integer	分页步长	是
attrKey	String	需要筛选的字段	是
attrValue	String	需要筛选的值	是

请求示例

{
  "productId": "",
  "lang": "zh-CN",
  "pageNo": 1,
  "pageSize": 2000,
  "attrKey": "ishome",
  "attrValue": "true"
}

返回示例

{
  "result": {
    "gmtModified": 1544073110998,
    "data": "[{\"detailDisplay\":true,\"lang\":\"all\",\"summaryDisplay\":false,\"value\":false,\"key\":\"ishome\"},{\"detailDisplay\":true,\"lang\":\"all\",\"summaryDisplay\":false,\"value\":false,\"key\":\"supdevctrl\"},{\"detailDisplay\":true,\"lang\":\"all\",\"summaryDisplay\":false,\"value\":[{\"value\":\"\"}],\"key\":\"multistepslist\"},{\"detailDisplay\":true,\"lang\":\"all\",\"summaryDisplay\":true,\"value\":[\"hu1h6awyz1zatea6\"],\"key\":\"supdev\"},{\"contentId_dp\":\"112\",\"pinyin\":\"#\",\"contentId_dp_value\":\"\",\"detailDisplay\":true,\"switch_dp\":\"102\",\"lang\":\"zh-CN\",\"summaryDisplay\":true,\"value\":\"MTE=\",\"key\":\"name\"},{\"detailDisplay\":true,\"lang\":\"all\",\"summaryDisplay\":true,\"value\":\"https://images.tuyacn.com/smart/user_res/ay152472768202199f4N/content/Group-A1S.png\",\"key\":\"picture\"},{\"detailDisplay\":true,\"lang\":\"all\",\"summaryDisplay\":false,\"value\":\"https://images.tuyacn.com/smart/user_res/ay152472768202199f4N/content/222.mp4\",\"key\":\"video\"},{\"detailDisplay\":true,\"lang\":\"zh-CN\",\"summaryDisplay\":false,\"value\":\"MTEx\",\"key\":\"introduction\"},{\"detailDisplay\":true,\"lang\":\"en\",\"summaryDisplay\":false,\"value\":\"\",\"key\":\"introduction\"},{\"detailDisplay\":true,\"lang\":\"zh-CN\",\"summaryDisplay\":false,\"value\":\"MTE=\",\"key\":\"ingredients\"},{\"detailDisplay\":true,\"lang\":\"zh-CN\",\"summaryDisplay\":false,\"value\":\"MTEx\",\"key\":\"stepsdsc\"},{\"detailDisplay\":true,\"lang\":\"zh-CN\",\"summaryDisplay\":true,\"value\":\"中文\",\"key\":\"categoryName\"},{\"detailDisplay\":true,\"lang\":\"all\",\"summaryDisplay\":false,\"value\":{\"devCtrl\":{\"supCookingStep\":false,\"stepValue\":\"\",\"isdevctrl\":true,\"cookingStepMode\":false,\"items\":[{\"label\":\"温度\",\"value\":\"\"}]},\"cooking\":[{\"finishedItem\":\"0\",\"items\":[{\"label\":\"温度\",\"value\":\"\"}],\"picture\":\"\"}]},\"key\":\"hmsteps\"}]",
    "contentId": "1070546336010547200",
    "name": null,
    "remark": null,
    "id": 1158,
    "gmtCreate": 1544073110998,
    "categoryName": null,
    "picture": null,
    "status": "0"
  },
  "code": "0",
  "success": true,
  "errorResult": null,
  "message": "success"
}

获取收藏菜谱列表

API 名称

tuya.industry.cookbook.starlist

API 版本

1.0

参数

名称	类型	描述	是否必选
pid	String	产品 ID	是
lang	String	多语言标识符，中文为 zh-CN	是

请求示例

{
  "lang": "zh-CN",
  "pid": ""
}

返回示例

{
  "result" : {
    "contentList": []
  },
  "t" : 1527771204905,
  "success" : true,
  "status" : "ok"
}

单个菜谱收藏情况

API 名称

tuya.industry.cookbook.starinfo

API 版本

1.0

参数

名称	类型	描述	是否必选
pid	String	产品 ID	是
contentId	String	菜谱 ID	是

请求示例

{
  "contentId": "",
  "pid": ""
}

返回示例

{
  "result" : true,
  "t" : 1527771204905,
  "success" : true,
  "status" : "ok"
}

收藏菜谱

API 名称

tuya.industry.cookbook.star

API 版本

1.0

参数

名称	类型	描述	是否必选
pid	String	产品 ID	是
contentId	String	菜谱 ID	是

请求示例

{
  "contentId": "",
  "pid": ""
}

返回示例

{
  "result": true,
  "t":1527767595606,
  "success":true,
  "status":"ok"
}

取消收藏菜谱

API 名称

tuya.industry.cookbook.unStar

API 版本

1.0

参数

名称	类型	描述	是否必选
pid	String	产品 ID	是
contentId	String	菜谱 ID	是

请求示例

{
  "contentId": "",
  "pid": ""
}

返回示例

{
  "result":true,
  "t":1527767595606,
  "success":true,
  "status":"ok"
}

获取 PID 下的菜谱品类

API 名称

tuya.industry.cookbook.category.search

API 版本

1.0

参数

名称	类型	描述	是否必选
pid	String	产品 ID	否
lang	String	多语言标识符，中文为 zh-CN	否
uid	String	用户标示	否

请求示例

{
  "productId": "",
  "lang": "zh-CN",
  "uid": ""
}

返回示例

{
  "result" : {
    "categoryList": []
  },
  "t" : 1527771204905,
  "success" : true,
  "status" : "ok"
}

下发菜谱指令

API 名称

tuya.ia.content.dispatchMultiDps

API 版本

1.0

参数

名称	类型	描述	是否必选
productId	String	产品 ID	是
contentId	String	菜谱 ID	是
deviceId	String	设备 ID	是

请求示例

{
  "productId": "",
  "contentId": "",
  "deviceId": ""
}

返回示例

{
  "result" : {},
  "t" : 1527771204905,
  "success" : true,
  "status" : "ok"
}

菜谱列表获取（新接口数据）

API 名称

tuya.ia.content.public.online.list

API 版本

1.0

参数

名称	类型	描述	是否必选
productId	String	产品 ID	是
contentType	String	查询类型，默认为 cookbook	是
nameSearch	String	菜谱名称	否
pageNo	Integer	分页标示	是
pageSize	Integer	分页步长	是
categoryName	String	菜谱品类名	否

请求示例

{
  "productId": "",
  "contentType": "cookbook",
  "pageNo": 1,
  "pageSize": 2000,
  "categoryName": ""
}

返回示例

{
  "result" : {
    "contentList": []
  },
  "t" : 1527771204905,
  "success" : true,
  "status" : "ok"
}

根据后台 ID 查找菜谱详情

API 名称

tuya.ia.content.id.detail

API 版本

1.0

参数

名称	类型	描述	是否必选
productId	String	产品 ID	是
id	String	ID	是

请求示例

{
  "productId": "",
  "id": "",
}

返回示例

{
  "result" : {},
  "t" : 1527771204905,
  "success" : true,
  "status" : "ok"
}

按语言获取分类列表

API 名称

tuya.ia.content.langCategoryNames

API 版本

1.0

参数

名称	类型	描述	是否必选
lang	String	多语言	是

请求示例

{
  "lang": "",
}

返回示例

{
  "result" : {},
  "t" : 1527771204905,
  "success" : true,
  "status" : "ok"
}

获取分类列表

API 名称

tuya.ia.content.CategoryNames

API 版本

1.0

参数

无

返回示例

{
  "result" : {},
  "t" : 1527771204905,
  "success" : true,
  "status" : "ok"
}