查看源

接口路径：/api/app/getAppDataById

应用权限：作品——>作品信息

类型: GET

Author: Shang Pan,flame

Content-Type: application/x-www-form-urlencoded;charset=utf-8

接口描述 根据作品appid获取作品数据，包含作品组件数据

Request-headers:

Header	类型	是否必填	字段描述
X-Token	string	true	token

Query-parameters:

参数	类型	是否必填	字段描述
appid	string	false	兔展作品id
uid	string	false	第三方平台用户的用户id
companyId	string	false	第三方平台企业id

接口出参:

Field	类型	字段描述
code	string	状态码
errorCode	string	错误状态码
msg	string	状态描述
data	object	数据
└─id	string	作品ID
└─name	string	作品名称
└─desc	string	作品摘要描述
└─level	string	等级，高等级作品才拥有去版权底链权限
└─appStatus	string	作品处理状态
└─width	int32	作品宽度
└─height	int32	作品高度
└─materials	array	作品里所含的所有收费的素材
└─isMaterial	boolean	是否是含有付费素材的作品
└─isVideo	boolean	是否是含有一视视频的作品
└─templateId	string	使用模板，参考模板ID
└─musicName	string	背景音乐名称
└─musicAutoPlay	boolean	是否自动播放音乐，music_is_auto
└─musicId	string	背景音乐，文件ID
└─musicKey	string	背景音乐CDN唯一key
└─musicBucket	string	背景音乐CDN节点
└─musicServer	string	背景音乐CDN厂商：A-阿里云，Q-七牛
└─musicPath	string	背景音乐文件路径url，基于CDN + musicKey动态生成
└─musicMaterial	string	音乐素材，目前主要自动付费用，可扩展使用
└─imgId	string	作品封面图，文件ID
└─imgKey	string	imgurl,对应封面图key，可以从file表取出oss路径
└─imgBucket	string	作品封面图CDN节点
└─imgServer	string	作品封面图CDN厂商：A-阿里云，Q-七牛
└─imgPath	string	作品封面图文件路径url，基于CDN + imgKey动态生成
└─logoId	string	logo首页展示loading时的图片，关联file表ID
└─logoKey	string	LOGO CDN唯一key
└─logoBucket	string	LOGO CDN厂商：A-阿里云，Q-七牛
└─logoServer	string	LOGO CDN厂商：A-阿里云，Q-七牛
└─logoPath	string	首页展示loading时的图片路径url
└─createtime	string	创建时间
└─updatetime	string	更新时间
└─statetime	string	状态修改时间
└─state	string	1:'正常',2:'封禁',3:'白名单', 4: '可疑', 5: '已审核' ,101:'转换中',102:'转换完成' '9' 鸡汤作品
└─deeplink	string	deeplink内容,orgdeep表里面的，sql:GET_APP_BY_URL
└─deepshare	string	deepshare内容
└─device	string	设备尺寸
└─ext	string	app_ext 扩展信息，用于微信授权访问和一视扩展内容
└─tags	string	作品标签
└─appTitle	string	作品标题
└─userId	string	所属用户，参考用户ID
└─pfid	string	作品所属平台ID，用于数据统计，app_pfid
└─shortUrl	string	作品短地址
└─type	string	作品类型，1：场景作品，2：一页作品，3：一视作品，重构后一页作品只有一个页面，多个页面自动跳场景里面
└─appUrl	string	作品地址
└─editUrl	string	编辑地址
└─domainUrl	string	自定义域名URL
└─timeInterval	int32	自动翻页的时间0表示不自动翻页
└─gather	string	表单配置
└─switchGuide	boolean	是否需要页面切换指引
└─in	string	页面切换时进入动画
└─out	string	页面切换时离开动画
└─loop	boolean	是否允许循环播放
└─company	string	公司名称，底链使用
└─link	string	跳转链接，底链使用
└─showReport	boolean	是否显示举报功能
└─publish	boolean	是否发布作品
└─showViewCount	boolean	是否显示阅读数量
└─showComment	boolean	是否显示评论数量
└─appExtId	string	作品扩展表ID，老作品为空，新作品都会有的，只要生成更新的时候一定要传
└─fonts	string	切割的字体，切割后的css链接
└─appVersion	int8	作品版本(1:老作品转新作品,2:新作品,3:微信小程序作品)
└─brandType	int8	自定义logo选项，3:选择自定义logo,2:选择联合底标
└─animationApplyAll	int8	背景翻页动画是否应用所有(0:否,1:是)
└─source	string	作品来源：WEIXIN 表示微信小程序创建的作品，PC 表示PC端编辑器创建的作品
└─showWeChatHead	int8	封面是否显示微信头像(0:否,1:是)
└─isAdvertising	boolean	是否广告(流量主)作品：true:是,false:否
└─showPageDot	boolean	是否显示翻页小圆点(0:否，1:是)
└─clickDynamicParams	boolean	是否有组件开启了动态参数(0:否;1:是)
└─dataVersion	int64	编辑数据版本，在编辑器里每次保存都会更新为当前时间戳
└─forceUpdate	boolean	是否强制更新（true:是,false:否）
└─settings	string	作品设置信息，json格式
└─appContentSource	string	作品内容来源 GZH_ARTICLE 公众号文章, GZH_IMAGE 公众号图文素材
└─uid	string	第三方用户(腾讯云)id
└─companyId	string	第三方联合登录(腾讯云)id
└─sourceAppUserId	string	原始作者id
└─contentType	string	内容类型
└─videoCover	string	一视作品的封面
└─pages	array	页面列表
└─formStructVos	array	表单结构列表
└─cmpVideoVos	array	组件一视一视作品或者一视模板列表
└─submitVos	array	作品提交按钮属性
└─editorFirstFlag	int32	进入编辑器第一次保存标识,是：1
└─appImgMaterial	array	作品里所含的所有图片付费素材
└─firstPageScreenshot	string	首页截图
└─viewLimit	string	作品访问限制
└─editTemplateFlag	boolean	是否模板, 只用于模板编辑跳编辑器返回true
└─appPfid	string	作品所属平台ID，用于数据统计，app_pfid
└─createClient	int8	创建来源客户端(1:PC;2:员工)
└─channelId	int64	员工id（在员工端创建）
└─deptId	int64	部门id（在员工端创建）
└─appCreateTime	string	app表保存的createtime
└─posterInfo	array	未知参数
└─posterCoverUrl	string	去除付费内容的预览图
└─isPluginTemplate	boolean	是否是玩法模板
└─openStatus	int32	玩法模板开通状态，1：未开通,2：生效中，3：已过期，4：未开始，5即将过期
└─templatePlugins	array	模板内的玩法
└─approvalStatus	int32	内容审批状态

请求示例

Curl-example:
curl -X GET -k -H 'Content-Type: application/x-www-form-urlencoded;charset=utf-8' -H 'X-Token:Ufx7ncC_OjOmIpYe4Fvr7YvVgGA' -i https://devintegrate.rabbitpre.com/api/open/api/app/getAppDataById?appid=831f1d33-afad-4071-b9d7-f5e4b64c550a&uid=dujun&companyId=test_dujun_company

返回示例

{
    "code": "200",
    "errorCode": "SUCCESS",
    "msg": "ok",
    "data": {
        "id": "831f1d33-afad-4071-b9d7-f5e4b64c550a",
        "name": "我的兔展作品",
        "desc": "我用兔展做了一个超炫酷的H5,快来看看吧！",
        "level": "2",
        "width": 320,
        "height": 504,
        "isMaterial": false,
        "isVideo": false,
        "templateId": "",
        "musicName": "",
        "musicAutoPlay": false,
        "musicId": "",
        "imgId": "",
        "imgPath": "https://static.h5no1.com/rp/editor/default2.png",
        "logoId": "",
        "logoPath": "https://static.h5no1.com/rp/editor/logo.png",
        "createtime": 1648027709000,
        "updatetime": 1648047277000,
        "statetime": 1648027709000,
        "state": "1",
        "device": "iPhone5",
        "ext": "",
        "appTitle": "我的兔展作品",
        "userId": "6b46441e-45aa-4487-9d76-c982ca2eca7c",
        "pfid": "be_ZnraEJfyz",
        "shortUrl": "FxQUYefypoe",
        "type": "2",
        "appUrl": "http://renderer.dev.rabbitpre.com/m2/FxQUYefypoe",
        "timeInterval": 0,
        "gather": "",
        "switchGuide": true,
        "loop": false,
        "showReport": true,
        "publish": false,
        "showViewCount": true,
        "showComment": false,
        "appExtId": "8f867023-7df5-4d94-9f49-0bad4ee4e7f9",
        "fonts": "[]",
        "appVersion": 2,
        "brandType": 3,
        "animationApplyAll": 1,
        "isAdvertising": false,
        "showPageDot": true,
        "clickDynamicParams": false,
        "dataVersion": 1648047277097,
        "settings": "{\"forbidSlideAll\":false,\"relativePosition\":false,\"independentTitle\":false,\"disablePageBounce\":false,\"posterRelatedAppId\":\"\",\"enableUserSelect\":false,\"appNavigationBarConfig\":{},\"variables\":{\"system\":[{\"name\":\"作品名称\"},{\"name\":\"浏览量\"},{\"name\":\"日期\"},{\"format\":\"imageLink\",\"name\":\"上传的图片\"},{\"format\":\"imageLink\",\"name\":\"轮播的图片\"},{\"format\":\"imageLink\",\"name\":\"人脸变化图片\"}],\"user\":[{\"format\":\"imageLink\",\"name\":\"微信头像\"},{\"name\":\"微信昵称\"}],\"form\":[],\"custom\":[]},\"flowEnabled\":false,\"designerFlag\":false,\"auth\":{},\"styleList\":[{\"id\":\"164802770701775\",\"type\":\"text\",\"name\":\"默认样式\",\"style\":{\"fontFamily\":\"SYHT\",\"fontSize\":16,\"lineHeight\":18,\"letterSpacing\":0,\"fontWeight\":\"normal\",\"fontStyle\":\"normal\",\"textDecoration\":\"none\",\"textAlign\":\"left\",\"writingMode\":\"\",\"backgroundColor\":\"transparent\",\"color\":\"#333\"},\"materials\":[]}],\"workbench\":null}",
        "appContentSource": "",
        "contentType": "activityPage",
        "pages": [
            {
                "id": "784c591e-c378-442c-b4e7-c5e02cf210c7",
                "pageExtId": "6d004b5a-6059-4824-b5cd-06b8f8aa5298",
                "appId": "831f1d33-afad-4071-b9d7-f5e4b64c550a",
                "cmps": "txt/20220323/aefcc5e1-84d5-4837-9cfe-a8214a36319a.txt",
                "cmpsJson": "[]",
                "createtime": 1648027709000,
                "updatetime": 1648047277000,
                "row": 0,
                "col": 0,
                "bgColor": "#fff",
                "bgImage": "",
                "bgServer": "",
                "bgLeft": 0,
                "bgTop": 0,
                "in": "",
                "out": "",
                "width": 320,
                "height": 504,
                "opacity": 1,
                "bgImageType": 0,
                "formatVersion": "2.0",
                "duration": 0.8,
                "imageMaterials": "",
                "settings": "{\"forbidSlide\":false,\"type\":\"page\",\"fullscreenBgValid\":false,\"pageScroll\":true,\"resizeLock\":false}"
            }
        ],
        "formStructVos": [],
        "editTemplateFlag": false,
        "appPfid": "be_ZnraEJfyz",
        "createClient": 1,
        "pluginTemplate": false
    }
}