写在前面:项目接口均需要签名校验,签名生成方式 https://docs.tuzhanai.com/pages/viewpage.action?pageId=1933345
1、新增平台专区-查询所有标签【系统及自定义】接口
接口路径:https://open.rabbitpre.com/api/template/platform/getAllTags
签名规则详见 https://docs.tuzhanai.com/pages/viewpage.action?pageId=1933345
请求方式:GET
入参:
参数 | 必选 | 类型 | 说明 |
---|---|---|---|
opfid | true | string | 第三方平台的用户id |
返回参说明:
参数 | 类型 | 说明 |
---|---|---|
customTags | list | 表示自定义标签: //标签名称 |
systemTags | list | 表示系统标签 //三级分类key |
返回参数格式:
{
"code": "200",
"errorCode": "SUCCESS",
"msg": "ok",
"data": {
"systemTags": [
{
"firstId": "1",
"name": "展示页",
"children": [
{
"id": "1471373184247824385",
"name": "用途",
"fieldKey": "tplScene",
"hideFlag": 0,
"children": [
{
"id": "1518056578485723138",
"name": "事件祝福",
"fieldKey": "EVENT",
"hideFlag": 0
},
{
"id": "1518056578489917441",
"name": "周年庆",
"fieldKey": "ANNIVERSARY",
"hideFlag": 0
}
]
}
]
}
],
"customTags": [
{
"groupId": 91,
"groupName": "用途类",
"hideFlag": 0,
"tags": [
{
"tagId": 510,
"name": "拉新获客",
"type": 2,
"createTime": 1650613758000
},
{
"tagId": 511,
"name": "老带新",
"type": 2,
"createTime": 1650613758000
}
]
},
{
"groupId": 142,
"groupName": "阿萨德",
"hideFlag": 0,
"tags": [
{
"tagId": 613,
"name": "1222",
"type": 2,
"createTime": 1650971387000
}
]
}
]
}
}
2、新增平台专区-查询平台模板列表接口
【旧项目】接口路径: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 |
入参格式
{
"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 | 模板描述 |
appId | string | 作品id(作品转模板后,记录的作品id) |
createTime | string | 创建时间 |
updateTime | string | 更新时间 |
userId | string | 创建模板的用户id |
hotSort | string | 排序字段(平台模板用此字段) |
tplType | string | 系统模板(S)或个人模板(P),企业账号建立的模板(C) |
tplShelf | string | 模版状态,1:上架,2:下架 11:冻结 |
tplPrice | double | 模板价格 |
tplState | string | 审核状态,2:审核中 ,3:审核成功 ,4:不通过 (平台模板可以不关注此字段) |
tplBillState | integer | 单据状态,判断当前是否需要进行审核(平台模板可以不关注此字段) |
tplExported | integer | 导出状态(1:已经导出,其他:未导出)(平台模板可以不关注此字段) |
tplInited | integer | 初始化状态(0:初始模板)(平台模板可以不关注此字段) |
tplFreeLimit | integer | 是否是企业专享模板(0:不是,1:是)(平台模板可以不关注此字段) |
tplOrganizePrice | double | 模板企业价格 |
tplVideo | integer | 是否含有视频(0不含有,1含有) |
appVersion | string | 作品的编辑器版本 |
materialFlag | string | 是否包含付费素材(0:不包含。 1:包含) |
buyFlag | string | 购买标记 0未购买、1已购买 |
buyDetail | string | 购买标记的文案 |
tplImg | string | 模板封面图片url(tplCoversFilepath不为空用tplCoversFilepath) |
tplExt | string | 扩展字段(height:模板高度) |
tplViewcount | integer | 模板浏览次数 |
tplAmount | integer | 模板使用量 |
tplCoversFilepath | string | 模板封面图片url(值为空时用tplimg) |
tplSpecies | integer | 模板类型 1:翻页 2:长页 3:视频 15:海报 |
previewUrl | string | 预览url |
label | list | 标签列表: [ |
openFlag | boolean | 是否开通标记(目前暂不支持开通方面功能,暂未做处理) |
collectionTpl | boolean | 是否收藏 |
pluginId | integer | 插件ID |
pluginClassifyId | integer | 插件分类ID |
video | string | 视频字段(平台模板可以不关注此字段,未对此字段作处理) |
conversionRate | string | 转化率(平台模板可以不关注此字段,未对此字段作处理) |
sort | string | 排序(平台模板可以不关注此字段,未对此字段作处理) |
videoWidth | string | 视频宽度(平台模板可以不关注此字段,未对此字段作处理) |
videoHeight | string | 视频高度(平台模板可以不关注此字段,未对此字段作处理) |
duration | string | (平台模板可以不关注此字段,未对此字段作处理) |
elementsText | string | (平台模板可以不关注此字段,未对此字段作处理) |
elementsImage | string | (平台模板可以不关注此字段,未对此字段作处理) |
elementsVideo | string | (平台模板可以不关注此字段,未对此字段作处理) |
image | string | (平台模板可以不关注此字段,未对此字段作处理) |
返回参数具体格式
{
"code": "200",
"errorCode": "SUCCESS",
"msg": "ok",
"data": {
"pageNo": 1,
"pageSize": 10,
"totalRecords": 0,
"longTotalRecords": 415,
"data": [
{
"id": "a4de0deb7c6ccc7449943bba7ebbd065",
"title": "(勿动!)qwl投票列表-瀑布+列表-作品页+弹窗-混合20",
"desc": "我用兔展做了一个超炫酷的H5,快来看看吧!",
"createTime": "2022-05-23 14:01:01",
"updateTime": "2022-05-23 14:01:01",
"userId": "2e70436b-007b-465f-a362-ab6fd2fcae62",
"sort": "0",
"hotSort": 0,
"conversionRate": -1.0,
"tplImg": "e37b3321-4a06-4079-a961-fdcfc60105f0",
"tplType": "P",
"tplViewCount": 0,
"tplPrice": 0.0,
"tplState": "3",
"tplShelf": "1",
"tplBillState": 1,
"tplExported": 0,
"tplInited": 1,
"remark": "1",
"tplFreeLimit": 1,
"tplOrganizePrice": 0.0,
"tplExt": "{\"height\":1512}",
"tplSpecies": "2",
"tplCoversFilepath": "https://test-cdn1.rabbitpre.com/0e063aa2-1af0-4c43-b2c1-a33394dee653",
"tplVideo": 0,
"tplSortRecommend": "11",
"tplSortSpavideo": "11",
"tplSortEseelandingpage": "11",
"tplSpecialSort": 1111,
"appVersion": 2,
"materialFlag": 0,
"pluginId": 10,
"pluginClassifyId": 25,
"defaultTemplate": 0,
"buyFlag": 0,
"buyDetail": "未购买",
"minimumPrice": 0.0,
"previewUrl": "http://renderer.test.rabbitpre.com/template/preview/a4de0deb7c6ccc7449943bba7ebbd065?mobile=1&autoplay=1",
"video": "",
"image": "",
"videoWidth": 0,
"videoHeight": 0,
"duration": 0,
"elementsText": 0,
"elementsImage": 0,
"elementsVideo": 0,
"labels": [
{
"tagId": 134,
"name": "个人",
"type": 1
},
{
"tagId": 204,
"name": "报名培训",
"type": 1
},
{
"tagId": 309,
"name": "元旦",
"type": 1
},
{
"tagId": 399,
"name": "其他",
"type": 1
},
{
"tagId": 408,
"name": "相册",
"type": 1
},
{
"tagId": 412,
"name": "简约",
"type": 1
},
{
"tagId": 419,
"name": "清新",
"type": 1
},
{
"tagId": 600,
"name": "手机海报",
"type": 1
},
{
"tagId": 1001,
"name": "互动创意型",
"type": 1
}
],
"openFlag": false,
"collectionTpl": false
}
{
"id": "71795ab7-da98-47d8-8b2c-bc7e69749a3b",
"title": "我的兔展作品",
"desc": "我用兔展做了一个超炫酷的H5,快来看看吧!",
"appId": "58f37950-6097-4438-86cf-90028fbf34a4",
"createTime": "2022-04-21 17:38:22",
"updateTime": "2022-05-13 09:09:02",
"userId": "2e70436b-007b-465f-a362-ab6fd2fcae62",
"hotSort": 111,
"tplImg": "6bf961d8-3959-47ed-b228-1c320448d0af",
"tplType": "P",
"tplAmount": 1,
"tplViewCount": 3,
"tplPrice": 0.0,
"tplState": "3",
"tplShelf": "1",
"tplBillState": 0,
"tplExported": 0,
"tplInited": 0,
"tplFreeLimit": 0,
"tplOrganizePrice": 0.0,
"tplExt": "{\"height\":504}",
"tplSpecies": "2",
"tplCoversFilepath": "https://oss1.rabbitpre.com/e809e577-e6c5-4d31-be9e-a0220c93066d",
"tplVideo": 0,
"appVersion": 2,
"materialFlag": 0,
"buyFlag": 0,
"buyDetail": "未购买",
"minimumPrice": 0.0,
"previewUrl": "http://renderer.test.rabbitpre.com/template/preview/71795ab7-da98-47d8-8b2c-bc7e69749a3b?mobile=1&autoplay=1",
"video": "",
"image": "",
"videoWidth": 0,
"videoHeight": 0,
"duration": 0,
"elementsText": 0,
"elementsImage": 0,
"elementsVideo": 0,
"openFlag": false,
"collectionTpl": false
}
]
}
}