【旧项目】接口路径:https://open.rabbitpre.com/api/template/platform/getAllTags
【新项目】接口路径:https://integrate.rabbitpre.com/api/open/api/template/platform/getAllTags
请求方式:GET
入参:
参数 | 必选 | 类型 | 说明 |
---|---|---|---|
opfid | true | string | 第三方平台的用户id |
返回参说明:
参数 | 类型 | 说明 |
---|---|---|
customTags | list | 表示自定义标签: |
systemTags | list | 表示系统标签 |
返回参数格式:
```json { "code": "string", "data": { "customTags": [ { "groupId": 0, "groupName": "string", "hideFlag": 0, "tags": [ { "createTime": "2022-04-19T02:37:59.420Z", "name": "string", "tagId": 0, "type": 0 } ] } ], "systemTags": [ { "children": [ { "children": [ {} ], "createTime": "2022-04-19T02:37:59.420Z", "fieldKey": "string", "hideFlag": 0, "id": 0, "name": "string" } ], "firstId": "string", "name": "string" } ] }, "errorCode": "string", "msg": "string" } ``` |
【旧项目】接口路径:https://open.rabbitpre.com/api/template/platform/list
【新项目】接口路径:https://integrate.rabbitpre.com/api/open/api/template/platform/list
请求方式:POST
入参填写要求:入参的customTagIds、systemTags、firstId是要根据/api/template/platform/getAllTags接口的返回参来进行填写的。
customTagIds,填写的根据getAllTags接口返回参数中customTags下的tagId,要查询那个自定义标签,只需要把tagId填写至customTagIds下即可
firstId,填写的根据getAllTags接口返回参数中systemTags下的firstId,firstId可以不填写,如果填写只能填写一个。表示的是你选择的哪个1级分类
systemTags,填写是getAllTags接口返回参数中systemTags下面的children下的每个元素的fieldkey进行填写。例如:我想查询用途下的会议邀请的模板,
这个时候组装的数据为
{
//用途的key
"secondFieldKey": "tplScen",
//会议邀请的key
"thirdFieldKey": "meet"
}
入参:
参数 | 必选 | 类型 | 说明 |
---|---|---|---|
userId | true | string | 用户id |
opfid | true | string | 平台id |
orgId | false | string | 企业id |
mostHot | false | boolean | true综合排序、false最新排序 |
pageNo | false | integer | 页码 |
pageSize | false | integer | 页大小 |
hidePayTemplate | false | boolean | 是否隐藏付费模板 |
firstId | false | integer | 系统标签1级分类的id |
customTagIds | false | list | 自定义标签id列表 |
systemTags | false | list | 系统标签列表: { //二级分类的key //三级分类的key |
入参格式
```json { "customTagIds": [ 0 ], "firstId": 0, "hidePayTemplate": false, "opfid": "string", "orgId": "string", "pageNo": 0, "pageSize": 0, "systemTags": [ { "secondFieldKey": "string", "thirdFieldKey": "string" } ], "userId": "string" } ``` |
返回参数:
参数 | 类型 | 说明 |
id | string | 模板id |
title | string | 模板标题 |
desc | string | 模板描述 |
tplImgUrl | string | 模板封面图片url(tplCoversFilepath不为空用tplCoversFilepath) |
tplExt | string | 扩展字段(height:模板高度) |
tplViewcount | integer | 模板浏览次数 |
tplAmount | integer | 模板使用量 |
tplCoversFilepath | string | 模板封面图片url(值为空时用tplimg) |
tplSpecies | integer | 模板类型 1:活动页,2:展示页,3:还阿波 |
previewUrl | string | 预览url |
tplState | string | 状态:已上架、已下架 |
label | list | 标签列表: [ |
返回参数具体格式
```json { "code": "string", "data": { "data": [ { "appId": "string", "appSortRecommend": 0, "appVersion": 0, "buyDetail": "string", "buyFlag": 0, "collectionTpl": true, "conversionRate": 0, "createTime": "yyyy-MM-dd HH:mm:ss", "defaultTemplate": 0, "desc": "string", "duration": 0, "elementsImage": 0, "elementsText": 0, "elementsVideo": 0, "filterItems": {}, "hotSort": 0, "id": "string", "image": "string", "labels": [ { "createTime": "2022-04-19T05:57:30.930Z", //标签名称 "name": "string", //标签id "tagId": 0, //标签类型 1、系统标签 2、自定义标签 "type": 0 } ], "materialFlag": 0, "minimumPrice": 0, "pluginClassifyId": 0, "pluginId": 0, "pluginPlayWayKey": "string", "previewUrl": "string", "remark": "string", "sort": "string", "title": "string", "tplAmount": 0, "tplBillState": "string", "tplCoversFilepath": "string", "tplDiscountRatio": 0, "tplExported": "string", "tplExt": "string", "tplFavorablePrice": 0, "tplFreeLimit": 0, "tplImg": "string", "tplImgUrl": "string", "tplInited": "string", "tplMobileClass": "string", "tplMobileSort": 0, "tplOrganize": "string", "tplOrganizeDiscount": 0, "tplOrganizePrice": 0, "tplParms": "string", "tplPrice": 0, "tplShelf": "string", "tplSortEseelandingpage": "string", "tplSortRecommend": "string", "tplSortSpavideo": "string", "tplSpecialSort": 0, "tplSpecies": "string", "tplState": "string", "tplTags": "string", "tplType": "string", "tplVideo": "string", "tplViewCount": 0, "tplZip": 0, "updateTime": "yyyy-MM-dd HH:mm:ss", "userId": "string", "video": "string", "videoHeight": 0, "videoWidth": 0, "videourl": "string", "vipSpecial": "string" } ], "longTotalRecords": 0, "pageNo": 0, "pageSize": 0, "scrollId": "string", "totalRecords": 0 }, "errorCode": "string", "msg": "string" } ``` |