作品接口


提供对作品信息进行增、删、改、查操作能力,具体功能包括:作品列表查询、作品创建、作品复制、作品删除、作品基础信息查询、作品分享设置、作品数据统计(pv、uv、获奖等)、获取表单结构等。

企业作品列表-无权限筛选

  • 接口描述:获取企业下面的所有作品列表。
  • 接口地址:/api/v1/editor/creation/list?token=TOKEN
  • 请求方式:GET
  • 传参方式:
  • 参数列表:
    参数名 是否必须 参数类型 说明
    openIds String 查询指定人的作品信息,逗号分隔
    type String 作品类型
    status Integer 作品状态
    authType Integer 0-未设置授权 1-公众号授权 2-手机号授权 3-自定义授权 4-无授权
    activityStatus Integer 活动状态
    auditStatus Integer 审核状态 -1-驳回 0-审核中 1-成功
    approveStatus Integer 审批状态 -1-驳回 0-审核中 1-成功
    name String 作品名称,支持模糊匹配
    pageNo Integer 分页查询,默认第一页
    pageSize Integer 分页查询,默认每页10条
  • 返回值示例:
    {
      "success": true,
      "code": "200",
      "msg": null,
      "obj": null,
      "map": {
          "pageNo": 1,
          "count": 1,
          "pageSize": 10,
          "end": true
      },
      "list": [
          {
              "id": 1,
              "type": "hd",
              "code": "OhujJ3YE",
              "title": "易企秀活动",
              "cover": "https://xxx.eqxiu.cn/xxx/xxx/Fm0TsFyxSh4FTmz1GmCx64-ZkrD1",
              "description": "我用易企秀做了一个超级炫酷的互动H5,快来看看吧。",
              "bizType": 2,
              "authType":1,
              "sourceId": 10096,
              "templateId": 10197,
              "originTemplateId": 10096,
              "status": 2,,
              "activityStatus": 2,
              "createUserName": "管理员",
              "property": "",
              "shareUrl": "http://xxx.eqxiu.cn/v/1?cc=7g06xtBR&e_ff_i=2209024",
              "createUser": "100864570a0c4e798fa621c1f3b357aa",
              "auditStatus": null,
              "approveStatus": null,
              "startTime": "2021-01-02 03:04:05",
              "endTime": "2022-01-02 03:04:05",
              "createTime": "2021-01-02 03:04:05",
              "updateTime": "2021-01-02 03:04:05",
              "publishTime": "2021-01-02 05:00:00"
          }
      ]
    }
    
  • 返回值说明:
    参数 参数类型 说明
    id Long(20) 作品ID
    type String(20) 作品类型
    code String(20) 作品唯一标识字符型
    title String(256) 作品标题
    cover String(256) 作品封面图,实际为全路径
    description String(512) 作品描述
    bizType int(2) 作品业务类型
    sourceId Long(20) 作品来源
    templateId Long(20) 作品模板
    originTemplateId Long(20) 原始模板
    status Int(4) 作品状态
    authType Int(4) 0-未设置授权 1-公众号授权 2-手机号授权 3-自定义授权 4-无授权
    activityStatus Int(4) 活动状态
    property String(2000) 附加属性
    createUser String(32) 创建人
    startTime Date 作品生效时间
    endTime Date 作品失效时间
    createTime Date 作品创建时间
    updateTime Date 作品更新时间
    publishTime Date 作品发布时间
    shareUrl String(256) 分享地址
    editUrl String(256) 编辑器地址,对接公司需要追加参数secretId=xxx以及Authorization=XXXXX,最终形态类似于https://xxx.eqxiu.cn/xx/xxxx?secretId=xxx&Authorization=XXXXX
    previewUrl String 作品预览地址,发布前或者内部体验地址。查看的数据是作品最新数据。对接公司使用时,需要追加token=xxxxx其中token获取作品预览token
    managerPreviewUrl String 管理端作品预览接口,需要追加参数Authorization=XXXX
    auditStatus int(2) 审核状态 -1-驳回 0-审核中 1或空-成功
    approveStatus int(2) 审批状态 -1-驳回 0-审核中 1或空-成功

企业作品列表-有权限筛选

  • 接口描述:获取企业下面当前账号权限的作品列表。
  • 接口地址:/api/v1/editor/creation/list/corpCreation?token=TOKEN&openId=OPEN_ID
  • 请求方式:GET
  • 传参方式:
  • 参数列表:
    参数名 是否必须 参数类型 说明
    type String 作品类型
    status Integer 作品状态
    authType Integer 0-未设置授权 1-公众号授权 2-手机号授权 3-自定义授权 4-无授权
    activityStatus Integer 活动状态
    title String 分类id 作品名称,支持模糊匹配
    groupId Long 分类id
    auditStatus Integer 审核状态 -1-驳回 0-审核中 1-成功
    approveStatus Integer 审批状态 -1-驳回 0-审核中 1-成功
    pageNo Integer 分页查询,默认第一页
    pageSize Integer 分页查询,默认每页10条
  • 返回值示例:
    {
      "success": true,
      "code": "200",
      "msg": null,
      "obj": null,
      "map": {
          "pageNo": 1,
          "count": 1,
          "pageSize": 10,
          "end": true
      },
      "list": [
          {
              "id": 1,
              "type": "hd",
              "code": "OhujJ3YE",
              "title": "易企秀活动",
              "cover": "https://xxx.eqxiu.cn/xxx/xxx/Fm0TsFyxSh4FTmz1GmCx64-ZkrD1",
              "description": "我用易企秀做了一个超级炫酷的互动H5,快来看看吧。",
              "bizType": 2,
              "authType":1,
              "sourceId": 10096,
              "templateId": 10197,
              "originTemplateId": 10096,
              "status": 2,,
              "activityStatus": 2,
              "createUserName": "管理员",
              "property": "",
              "createUser": "100864570a0c4e798fa621c1f3b357aa",
              "auditStatus": null,
              "approveStatus": null,
              "startTime": "2021-01-02 03:04:05",
              "endTime": "2022-01-02 03:04:05",
              "createTime": "2021-01-02 03:04:05",
              "updateTime": "2021-01-02 03:04:05",
              "publishTime": "2021-01-02 05:00:00"
          }
      ]
    }
    
  • 返回值说明:
    参数 参数类型 说明
    id Long(20) 作品ID
    type String(20) 作品类型
    code String(20) 作品唯一标识字符型
    title String(256) 作品标题
    cover String(256) 作品封面图,实际为全路径
    description String(512) 作品描述
    bizType int(2) 作品业务类型
    sourceId Long(20) 作品来源
    templateId Long(20) 作品模板
    originTemplateId Long(20) 原始模板
    status Int(4) 作品状态
    authType Int(4) 0-未设置授权 1-公众号授权 2-手机号授权 3-自定义授权 4-无授权
    activityStatus Int(4) 活动状态
    property String(2000) 附加属性
    createUser String(32) 创建人
    startTime Date 作品生效时间
    endTime Date 作品失效时间
    createTime Date 作品创建时间
    updateTime Date 作品更新时间
    publishTime Date 作品发布时间
    shareUrl String(256) 分享地址
    editUrl String(256) 编辑器地址,对接公司需要追加参数secretId=xxx以及Authorization=XXXXX,最终形态类似于https://xxx.eqxiu.cn/xx/xxxx?secretId=xxx&Authorization=XXXXX
    previewUrl String 作品预览地址,发布前或者内部体验地址。查看的数据是作品最新数据。对接公司使用时,需要追加token=xxxxx其中token获取作品预览token
    managerPreviewUrl String 管理端作品预览接口,需要追加参数Authorization=XXXX
    auditStatus int(2) 审核状态 -1-驳回 0-审核中 1或空-成功
    approveStatus int(2) 审批状态 -1-驳回 0-审核中 1或空-成功

第三方访客参与的作品列表(非互动-分页获取)

  • 接口描述:获取指定访客参与的所有作品列表(非互动类型走此接口)。

  • 接口地址:/api/v1/editor/creation/creation_by_customer/list?token=TOKEN

  • 请求方式:GET

  • 传参方式:

  • 参数列表:

    参数名 是否必须 参数类型 说明
    thirdUserId String 第三方访客id
    creationType String 作品类型
    pageNo Integer 分页查询,默认第一页
    pageSize Integer 分页查询,默认每页10条
  • 返回值示例:

    {
      "success": true,
      "code": "200",
      "msg": null,
      "obj": null,
      "map": {
          "pageNo": 1,
          "count": 1,
          "pageSize": 10,
          "end": true
      },
      "list": [
          {
              "id": 11762,
              "type": "hd",
              "code": "R97kSFo5",
              "title": "互动嵌入投票",
              "cover": "https://asset.eqxiu.cn/material/common/img/cover-form.png",
              "thumbnail": null,
              "description": "",
              "bizType": 1,
              "cyclePrize": null,
              "loadingLogo": null,
              "audio": null,
              "accessCode": null,
              "pageMode": null,
              "template": 0,
              "sourceId": 5000002,
              "templateId": null,
              "originTemplateId": 5000002,
              "checkStatus": null,
              "source": null,
              "status": 2,
              "property": "{\"userInfoUrl\":\"http://wxwork.yqxiu.cn/cmpdemo/auth/info\",\"openMsg\":false,\"voteType\":0,\"formPush\":false,\"upSlide\":0,\"votingVerification\":false,\"userCodeUrl\":\"http://wxwork.yqxiu.cn/cmpdemo/auth/authHtml\",\"wxAuthType\":1,\"channelVote\":false,\"configId\":6144,\"shareDes\":\"{}\",\"userType\":3,\"verification\":0}",
              "createUser": "9f03cddc9d664869a086b181011e22ef",
              "corpId": "43c5a5c1149c4206bb7089b755975382",
              "startTime": null,
              "endTime": null,
              "createTime": "2022-07-26 09:44:35",
              "updateTime": "2022-07-26 09:47:56",
              "publishTime": "2022-07-26 09:46:24",
              "auditStatus": null,
              "approveStatus": null,
              "authType": 3
          }
      ]
    }
    
  • 返回值说明:

    参数 参数类型 说明
    id Long(20) 作品ID
    type String(20) 作品类型
    code String(20) 作品唯一标识字符型
    title String(256) 作品标题
    cover String(256) 作品封面图,实际为全路径
    thumbnail String(256) 作品缩略图(未使用)
    description String(512) 作品描述
    bizType int(2) 作品业务类型
    cyclePrize int(2) 周期性发奖,1:开启 0:不开启
    loadingLogo String(256) 加载logo(未使用)
    audio String(256) 背景音乐
    accessCode String(10) 访问密码(未使用)
    pageMode int(2) 翻页方式 1:左右翻页 2:上下翻页
    template int(2) 是否模板(未使用)
    sourceId Long(20) 作品来源
    templateId Long(20) 作品模板
    originTemplateId Long(20) 原始模板
    status Int(4) 作品状态
    authType Int(4) 0-未设置授权 1-公众号授权 2-手机号授权 3-自定义授权 4-无授权
    activityStatus Int(4) 活动状态
    property String(2000) 附加属性
    createUser String(32) 创建人
    startTime Date 作品生效时间
    endTime Date 作品失效时间
    createTime Date 作品创建时间
    updateTime Date 作品更新时间
    auditStatus int(2) 审核状态 -1-驳回 0-审核中 1或空-成功
    approveStatus int(2) 审批状态 -1-驳回 0-审核中 1或空-成功
    authType int(2) 授权类型 0-未设置授权 1-公众号授权 2-手机号授权 3-自定义授权 4-无授权

第三方访客参与的作品列表(互动-全量获取)

  • 接口描述:获取指定访客参与的所有互动作品列表。

  • 接口地址:/api/v1/editor/creation/creation_by_customer/list/hd?token=TOKEN

  • 请求方式:GET

  • 传参方式:

  • 参数列表:

    参数名 是否必须 参数类型 说明
    thirdUserId String 第三方访客id
  • 返回值示例:

    {
      "success": true,
      "code": "200",
      "msg": null,
      "obj": null,
      "list": [
          {
              "id": 61762,
              "type": "form",
              "code": "R97kSFo5",
              "title": "互动嵌入投票",
              "cover": "https://asset.eqxiu.cn/material/common/img/cover-form.png",
              "thumbnail": null,
              "description": "",
              "bizType": 102,
              "cyclePrize": null,
              "loadingLogo": null,
              "audio": null,
              "accessCode": null,
              "pageMode": null,
              "template": 0,
              "sourceId": 5000002,
              "templateId": null,
              "originTemplateId": 5000002,
              "checkStatus": null,
              "source": null,
              "status": 2,
              "property": "{\"userInfoUrl\":\"http://wxwork.yqxiu.cn/cmpdemo/auth/info\",\"openMsg\":false,\"voteType\":0,\"formPush\":false,\"upSlide\":0,\"votingVerification\":false,\"userCodeUrl\":\"http://wxwork.yqxiu.cn/cmpdemo/auth/authHtml\",\"wxAuthType\":1,\"channelVote\":false,\"configId\":6144,\"shareDes\":\"{}\",\"userType\":3,\"verification\":0}",
              "createUser": "9f03cddc9d664869a086b181011e22ef",
              "corpId": "43c5a5c1149c4206bb7089b755975382",
              "startTime": null,
              "endTime": null,
              "createTime": "2022-07-26 09:44:35",
              "updateTime": "2022-07-26 09:47:56",
              "publishTime": "2022-07-26 09:46:24",
              "auditStatus": null,
              "approveStatus": null,
              "authType": 3
          }
      ]
    }
    
  • 返回值说明:

    参数 参数类型 说明
    id Long(20) 作品ID
    type String(20) 作品类型
    code String(20) 作品唯一标识字符型
    title String(256) 作品标题
    cover String(256) 作品封面图,实际为全路径
    thumbnail String(256) 作品缩略图(未使用)
    description String(512) 作品描述
    bizType int(2) 作品业务类型
    cyclePrize int(2) 周期性发奖,1:开启 0:不开启
    loadingLogo String(256) 加载logo(未使用)
    audio String(256) 背景音乐
    accessCode String(10) 访问密码(未使用)
    pageMode int(2) 翻页方式 1:左右翻页 2:上下翻页
    template int(2) 是否模板(未使用)
    sourceId Long(20) 作品来源
    templateId Long(20) 作品模板
    originTemplateId Long(20) 原始模板
    status Int(4) 作品状态
    authType Int(4) 0-未设置授权 1-公众号授权 2-手机号授权 3-自定义授权 4-无授权
    activityStatus Int(4) 活动状态
    property String(2000) 附加属性
    createUser String(32) 创建人
    startTime Date 作品生效时间
    endTime Date 作品失效时间
    createTime Date 作品创建时间
    updateTime Date 作品更新时间
    auditStatus int(2) 审核状态
    approveStatus int(2) 审批状态
    authType int(2) 授权类型 0-未设置授权 1-公众号授权 2-手机号授权 3-自定义授权 4-无授权

创建作品

  • 接口描述:创建一个作品,空白创建或使用模板创建。

  • 接口地址:/api/v1/editor/creation/create?token=TOKEN&openId=OPEN_ID

  • 请求方式:POST

  • 传参方式:URL隐式参数

  • 参数列表:

    参数名 是否必须 参数类型 说明
    templateId Long 模板ID,空白创建时模版为空,互动模板此项必填
    type String 见“ 作品类型
    extra String 1. 见“ 表单类型 ”(表单空白创建时,此项必填)
    2. 见“ 海报类型 ”(海报空白创建时,此项必填)
    title String 作品标题,不传则使用模板的标题
    copyProperty boolean 是否复制作品的授权方式等属性,仅针对H5类型作品

    注:表单创建时,如果是模板创建,即templateId有值,extra将被忽略。

  • 返回值:

    {
      "success": true,
      "code": "200",
      "msg": null,
      "obj": {
          "creationId":10000,
          "url":"xxxxxx",
          "customParams": {
              "actId": 1
          }
      },
      "map": null,
      "list": []
    }
    
  • 返回值说明:

    参数 参数类型 说明
    creationId Long 作品ID
    url String 作品编辑器地址,用于创建完毕后的打开编辑
    customParams obj 通过模板创建作品时在模板页携带的格式为cp_xxx参数

发布作品

  • 注        意:如果刚创建作品,就调用该接口,可能存在不能预览的问题,慎用!!!
  • 接口描述:发布已创建的作品。
  • 接口地址:/api/v1/editor/creation/publish?token=TOKEN&openId=OPEN_ID
  • 请求方式:POST
  • 传参方式:URL隐式参数
  • 参数列表:
    参数名 是否必须 参数类型 说明
    creationId Long 作品ID
  • 返回值:
    {
      "success": true,
      "code": "200",
      "msg": null,
      "obj":null,
      "map": null,
      "list": []
    }
    

复制作品

  • 接口描述:根据作品ID复制一个作品。

  • 接口地址:/api/v1/editor/creation/copy?token=TOKEN&openId=OPEN_ID

  • 请求方式:POST

  • 传参方式:URL隐式参数

  • 参数列表:

    参数名 是否必须 参数类型 说明
    id Long 作品ID
    renamePrefix String 作品名前缀,如原作品为“易企秀作品”,复制后为“复制-易企秀作品”,即默认前缀为“复制-”
  • 返回值示例:

    {
      "success": true,
      "code": "200",
      "msg": null,
      "obj": 100000,
      "map": {},
      "list": []
    }
    
  • 返回值说明:

    参数 参数类型 说明
    obj Long 新作品的ID

删除作品

  • 接口描述:根据作品ID删除一个作品。

  • 接口地址:/api/v1/editor/creation/delete?TOKEN&openId=OPEN_ID

  • 请求方式:POST

  • 传参方式:URL隐式参数

  • 参数列表:

    参数名 是否必须 参数类型 说明
    id Long 作品ID
  • 返回值示例:

    {
      "success": true,
      "code": "200",
      "msg": null,
      "obj": 100000,
      "map": {},
      "list": []
    }
    
  • 返回值说明:

    参数 参数类型 说明
    obj Long 删除作品的ID

作品信息

  • 接口描述:根据作品ID获取作品信息。

  • 接口地址:/api/v1/editor/creation/info?token=TOKEN

  • 请求方式:GET

  • 传参方式:URL显式参数

  • 参数列表:

    参数名 是否必须 参数类型 说明
    id Long 作品ID
  • 返回值:

    {
      "success": true,
      "code": "200",
      "msg": null,
      "obj": {
              "id": 1,
              "type": "hd",
              "code": "OhujJ3YE",
              "title": "易企秀活动",
              "cover": "Fm0TsFyxSh4FTmz1GmCx64-ZkrD",
              "description": "我用易企秀做了一个超级炫酷的互动H5,快来看看吧。",
              "bizType": 2,
              "template": 0,
              "sourceId": 10096,
              "templateId": 10197,
              "openId":"xxxxx",
              "originTemplateId": 10096,
              "status": 2,
              "property": "",
              "shareUrl": "https://hanq1.eqxiu.cn/gs/OhujJ3YE",
              "previewUrl": "https://hanq1.eqxiu.cn/pv/OhujJ3YE",
              "managerPreviewUrl": "https://hanq1.eqxiu.cn/preview/OhujJ3YE",
              "createUser": "100864570a0c4e798fa621c1f3b357aa",
              "startTime": "2021-01-02 03:04:05",
              "endTime": "2022-01-02 03:04:05",
              "createTime": "2021-01-02 03:04:05",
              "updateTime": "2021-01-02 03:04:05",
              "publishTime": "2021-01-02 05:00:00"
      },
      "map": {},
      "list": []
    }
    
  • 返回值说明:

    参数 参数类型 说明
    id Long 作品ID
    type String 作品类型
    code String 作品唯一标识字符型
    title String 作品标题
    cover String 作品封面图,全路径
    description String 作品描述
    bizType int 作品业务类型
    template int 是否为模板,0:非模板,1:模板
    sourceId Long 作品来源
    templateId Long 作品模板
    openId String 作品创建者openId,对应于接口创建的合作客户员工唯一标识
    originTemplateId Long 原始模板
    status int 作品状态
    property String 附加属性
    createUser String 创建人
    startTime Date 作品生效时间
    endTime Date 作品失效时间
    createTime Date 作品创建时间
    updateTime Date 作品更新时间
    publishTime Date 作品发布时间
    shareUrl String 分享地址
    editUrl String 编辑器地址,对接公司需要追加参数secretId=xxx以及Authorization=XXXXX,最终形态类似于https://xxx.eqxiu.cn/xx/xxxx?secretId=xxx&Authorization=XXXXX
    previewUrl String 作品预览地址,发布前或者内部体验地址。查看的数据是作品最新数据。对接公司使用时,需要追加token=xxxxx其中token获取作品预览token
    managerPreviewUrl String 管理端作品预览接口,需要追加参数Authorization=XXXX

作品预览token

  • 接口描述:根据作品ID获取作品预览token。

  • 接口地址:/api/v1/editor/creation/preview/token?token=TOKEN

  • 请求方式:POST

  • 传参方式:URL隐式参数

  • 参数列表:

    参数名 是否必须 参数类型 说明
    creationId Long 作品ID
  • 返回值:

    {
      "success": true,
      "code": "200",
      "msg": null,
      "obj":"xxxxxxxxxx",
      "map": {},
      "list": []
    }
    
  • 返回值说明:

    参数 参数类型 说明
    obj String 作品的预览token,绑定作品,有效期为30分钟

    拿到token后将token放到预览链接上即可无需授权预览活动。活动链接:https://www.eqxiu.cn/pv/10086?token={token}

分享设置

  • 接口描述:设置作品分享信息。

  • 接口地址:/api/v1/editor/creation/share/setting?token=TOKEN

  • 请求方式:POST

  • 传参方式:URL隐式参数

  • 参数列表:

    参数名 是否必须 参数类型 说明
    id Long 作品ID
    title String 作品标题
    cover String 作品封面
    description String 作品描述
  • 返回参数:

    {
      "success": true,
      "code": "200"
    }
    

表单表头结构

  • 接口描述:仅支持H5、长页、表单
  • 接口地址:/api/v1/editor/form/formMeta?token=TOKEN
  • 请求方式:POST
  • 传参方式:URL显式参数
  • 参数列表:
    参数名 是否必须 参数类型 说明
    creationId Long 作品ID
    showTrash Int 是否展示已删除Meta(默认不展示),0:不展示 1:展示
  • 代码示例:
    {
      "success": true,
      "code": "200",
      "msg": null,
      "obj": {
          "4324240482": {
              "score": "{\"score\":10,\"showScoreAndAnswer\":false,\"answers\":[],\"answerKeys\":\"\",\"scoreMethodType\":2,\"list\":[{\"score\":10,\"default\":false,\"id\":1,\"label\":\"选项1\",\"tag\":\"custom\"},{\"score\":10,\"default\":false,\"id\":2,\"label\":\"选项2\",\"tag\":\"custom\"},{\"score\":10,\"default\":false,\"id\":3,\"label\":\"选项3\",\"tag\":\"custom\"}]}",
              "num": 1,
              "options": null,
              "type": "scoreRadio",
              "title": "单选题",
              "delFlag": false,
              "status": null
          },
          "6371792593": {
              "score": "{\"showScoreAndAnswer\":false}",
              "num": 2,
              "options": null,
              "type": "5210",
              "title": "单项填空",
              "delFlag": false,
              "status": null
          }
      },
      "map": null,
      "list": null,
      "details": null
    }
    
  • 返回参数:
    参数名 是否必须 参数类型 说明
    score Json String 选项和得分
    type String 组件类型
    title String 标题
    delFlag Boolean 是否删除

作品页面编号

  • 接口描述:获取作品页面的编号信息。
  • 接口地址:/api/v1/editor/creation/page/list/simple?token=TOKEN
  • 请求方式:GET
  • 传参方式:
  • 参数列表:
    参数名 是否必须 参数类型 说明
    creationId Long 作品ID
  • 代码示例:
    {
      "success": true,
      "code": "200",
      "msg": null,
      "obj": null,
      "map": null,
      "list": [
          {
              "id": 50009,
              "pageNo": 1
          },
          {
              "id": 50010,
              "pageNo": 2
          },
          ...
      ]
    }
    
  • 返回参数:
    参数 参数类型 说明
    id Long 页面ID
    pageNo Integer 页码

作品页面截图

  • 接口描述:生成作品页面的截图,暂时只支持翻页作品。
  • 接口地址:/api/v1/editor/design/pic/creation/snapshot?token=TOKEN
  • 请求方式:GET/POST
  • 传参方式:
  • 参数列表:
    参数名 是否必须 参数类型 说明
    creationId Long 作品ID
    pageId Long 作品页面编号
  • 代码示例:

  • 返回参数:png文件流


will 2024年9月20日 10:59 8880 收藏文档