背景说明:
兔展支持通过api接口实现作品的管理;
功能详情:
1、获取作品列表
接口地址:获取作品列表
...
使用说明:通过该接口可以获取当前账号下的作品信息,支持租户模式下跨企业查询
功能说明:通过该接口可以获取作品详情,包括作品相关信息。
兔展作品列表:
接口协议:HTTPS
HTTP请求方式:GET
请求参数
...
参数
...
必选
...
类型
...
说明
...
companyId
...
false
...
string
...
uid
...
true
...
string
...
第三方平台的用户id
...
keyword
...
false
...
string
...
作品名称
...
pageNo
...
false
...
integer
...
页码,从1开始的正整数
...
pageSize
...
false
...
integer
...
每页数量,从1开始的正整数
返回参数
...
orgDomain
...
使用说明:通过该接口可以根据当前uid账号下的作品id,查询作品详情,支持租户模式下跨企业查询
兔展作品列表:
接口协议:HTTPS
HTTP请求方式:GET
请求参数
...
参数
...
必选
...
类型
...
说明
...
companyId
...
false
...
string
...
第三方平台的企业id,如果没有则不必传,有则传,其他接口必须保持一致
...
uid
...
true
...
string
...
第三方平台的用户id
...
ids
...
true
...
string
...
兔展作品id,多个以‘,’分隔
返回参数
...
orgDomain
...
使用说明:通过该接口可以修改当前账号下的作品信息,比如作品名称、作品描述、作品封面。
兔展分享设置:
接口协议:HTTPS
HTTP请求方式:POST
请求参数
...
参数
...
必选
...
类型
...
说明
...
companyId
...
false
...
string
...
第三方平台的企业id,如果没有则不必传,有则传,其他接口必须保持一致
...
uid
...
true
...
string
...
第三方平台的用户id
...
appid
...
true
...
string
...
作品id
...
shareTitle
...
true
...
string
...
分享标题
...
shareDesc
...
true
...
string
...
分享描述
...
shareImg
...
true
...
string
...
分享图片url
...
showViewFlag
...
true
...
integer
...
是否显示阅读数,0:不显示;1:显示
...
高级功能设置,json格式字符串。
示例
{
"workbench":{
"wxAuthMode":"3"
}
}
示例说明
enum AUTH_MODE {
/** 明文授权 */
SNSAPI_USERINFO = '0',
/** 静默授权 */
SNSAPI_BASE = '1',
/** 先静默后明文授权 */
SNSAPI_BOTH = '2',
/** 强制明文授权 */
FORCE_SNSAPI_USERINFO = '3',
}
2、根据作品ids获取作品信息
接口地址:根据作品ID获取作品信息和玩法信息
使用说明:通过该接口可以根据当前uid账号下的作品id,查询作品详情,支持租户模式下跨企业查询
3、作品分享设置
接口地址:根据作品ID获取作品信息和玩法信息
使用说明:通过该接口可以修改当前账号下的作品信息,比如作品名称、作品描述、作品封面。
4、删除作品
接口地址:删除作品
使用说明:通过该接口可以删除对应账户下的作品
5、作品封禁
接口地址:作品封禁
使用说明:通过该接口可以封禁对应账户下的作品,用户不可再进入已封禁的作品,如需解封,请联系兔展运营人员。
6、复制作品
接口地址:复制作品
使用说明:通过该接口可以复制对应账户下的作品
7、作品上下线
接口地址:作品上下线
使用说明:通过该接口可以操作对应账户下的作品的发布和下线
8、获取作品海报二维码信息
接口地址:获取作品海报二维码信息
使用说明:通过该接口可以获取对应账户下的作品的海报二维码的信息
9、获取作品封面
接口地址:获取作品封面
使用说明:通过该接口可以获取对应账户下的作品封面
10、获取作品的玩法
接口地址:获取作品的玩法
返回参数
...
4、删除作品
接口协议:HTTPS
HTTP请求方式:POST
请求参数
...
参数
...
必选
...
类型
...
说明
...
companyId
...
false
...
string
...
第三方平台的企业id,如果没有则不必传,有则传,其他接口必须保持一致
...
uid
...
true
...
string
...
第三方平台的用户id
...
appid
...
true
...
integer
...
作品id
返回参数
...
5、作品封禁
接口协议:HTTPS
HTTP请求方式:POST
请求参数
...
参数
...
必选
...
类型
...
说明
...
companyId
...
false
...
string
...
第三方平台的企业id,如果没有则不必传,有则传,其他接口必须保持一致
...
uid
...
true
...
string
...
第三方平台的用户id
...
...
true
...
string
...
兔展的作品id
返回参数示例
{
"code": "200",
"errorCode": "SUCCESS",
"msg": "ok"
}
6、复制作品
请求参数:
...
参数
...
类型
...
必选
...
说明
...
opfid
...
string
...
true
...
开放平台ID
...
nonce
...
string
...
true
...
6位随机字串不能为空
...
timestamp
...
string
...
true
...
签名时间戳
...
signature
...
string
...
true
...
签名
...
uid
...
string
...
true
...
第三方平台的用户id
...
appid
...
string
...
true
...
作品id
返回参数:
...
参数
...
类型
...
说明
...
code
...
string
...
状态码
...
errorCode
...
string
...
错误状态码
...
msg
...
string
...
状态描述
...
data
...
object
...
数据
...
└─id
...
string
...
作品id
...
└─name
...
string
...
作品名
...
└─desc
...
string
...
作品说明
...
└─appUrl
...
string
...
作品短链全路径url
7、作品上下线
接口协议:HTTPS
HTTP请求方式:GET
请求参数:
...
参数
...
类型
...
必选
...
说明
...
opfid
...
string
...
true
...
开放平台ID
...
nonce
...
string
...
true
...
6位随机字串不能为空
...
timestamp
...
string
...
true
...
签名时间戳
...
signature
...
string
...
true
...
签名
...
appId
...
string
...
true
...
作品id
...
status
...
string
...
true
...
作品状态:1-上线 201-下线
...
uid
...
String
...
true
...
第三方平台的用户id
...
String
...
true
...
editor:编辑器制作
xapp:外部导入
gzharticle:公众号图文素材导入(公众号文章)
gzhimage:公众号图文素材导入
返回参数:
...
参数
...
类型
...
说明
...
code
...
string
...
状态码
...
errorCode
...
string
...
错误状态码
...
msg
...
string
...
状态描述
...
data
...
object
...
数据
接口协议:HTTPS
HTTP请求方式:GET
请求参数
...
参数
...
必选
...
类型
...
说明
...
qrCodeId
...
false
...
long
...
二维码id,海报扫码场景值去除audienceScanPush部分
返回参数
...
cnlType
...
9、获取作品封面
接口协议:HTTPS
HTTP请求方式:GET
请求参数
...
参数
...
必选
...
类型
...
说明
...
appid
...
true
...
string
...
兔展作品id
请求示例
换行和缩进只是为了更好的展示:
https://open.rabbitpre.com/api/app/getAppCover
返回参数
...
10、获取作品的玩法
接口协议:HTTPS
HTTP请求方式:GET
请求参数:
...
参数
...
类型
...
必选
...
说明
...
appId
...
string
...
true
...
作品id
...
返回参数:
...
参数
...
类型
...
说明
...
code
...
string
...
状态码
...
errorCode
...
string
...
错误状态码
...
msg
...
string
...
状态描述
...
data
...
array
...
数据
...
└─componentId
...
string
...
组件Id
...
└─componentName
...
string
...
组件名称
...
└─pluginName
...
string
...
玩法名称。可选值,参考示例
...
└─deleted
...
int32
...
删除标志 0: 未删除 1:删除
...
玩法name(pluginName)
...
玩法title
...
使用说明:通过该接口可以获取对应账户下的作品玩法