动态替换作品元素


根据元素Name动态替换作品数据。目前支持对文本、图片以及二维码元素的内容替换。

使用步骤

  1. 使用H5编辑器设计一个模板作品;
  2. 给需要动态替换的元素设置Name属性;
  3. 调用“动态参数配置”接口进行配置;
  4. 访问作品详情页的URL携带参数dataId;

配置说明

  • name属性设置:
    进入H5作品编辑 -> 选中对应元素 -> 高级 -> Name赋值

  • 操作演示截图如下:

接口说明

动态参数配置

  • 接口地址:/api/v1/editor/creation/dyn/data/save?token=ACCESS_TOKEN

  • 方法类型:POST

  • 请求方式:multipart/form-data

  • 请求参数

    参数名 是否必须 参数类型 参数说明
    creationId 必须 Integer 作品Id
    dataId 必须 String 动态参数id,长度在32位以内。同一个作品可以有多个dataId。在访问作品详情页时携带。
    元素name(如上图中的introduce) String 至少有一个。key为在编辑器中配置的Name名,value为改元素要替换的值。
  • 补充说明

  1. 若需要替换多个元素,直接在请求参数传入相关name值即可:
    以下为将作品ID为1000,元素Name为wxNickName的值替换为zhangsan,wxImg替换为https://asset.eqh5.com/FtGM-RuFdGH9p0gtskYmME31DiBy 的请求参数示例:
    creationId=1000&dataId=00744fb2be924f5691c4b0dea02263a3&wxNickName=zhangsan&wxImg=https://asset.eqh5.com/FtGM-RuFdGH9p0gtskYmME31DiBy
    
    作品预览链接为:https://asset.eqh5.com/FtGM-RuFdGH9p0gtskYmME31DiBy?dataId=00744fb2be924f5691c4b0dea02263a3
  2. 传入的元素值请自行注意类型匹配。目前支持三种类型的元素替换。
    (1)图片,要替换的内容为图片的url。需能在公网正常访问且支持跨域。
    (2)文本,要替换的内容为文本内容。
    (3)二维码。在编辑器配置二维码的编辑方式有两种,自动生成和手动上传。自动生成时传二维码的文本内容,手动上传时传二维码的图片地址。
  • 正确时返回:
    {
      "success": true,
      "code": 200,
      "msg": "操作成功"
    }
    
    ● 错误时返回:
    {
      "success": false,
      "code": "B000005",
      "msg": "数据不存在"
    }
    

动态参数查询

  • 接口地址:/api/v1/editor/creation/dyn/data/list?token=ACCESS_TOKEN

  • 方法类型:GET

  • 请求参数

    参数名 是否必须 参数类型 参数说明
    creationId 必须 Integer 作品Id
  • 正确时返回:

    {
      "success": true,
      "code": 200,
      "msg": "操作成功",
      "list": [
          {
              "creationId": 1000,
              "dataId": "00744fb2be924f5691c4b0dea02263a3",
              "createTime": "2021-12-13 00:00:00",
              "updateTime": "2021-12-13 00:00:00",
              "dataInfo": "{\"wxNickName\":\"zhangsan\",\"wxImg\":\"https://asset.eqh5.com/FtGM-RuFdGH9p0gtskYmME31DiBy?imageView2/0/w/999/h/999\"}"
          }
      ]
    }
    
  • 错误时返回:

    {
      "success": false,
      "code": "B000005",
      "msg": "数据不存在"
    }
    

    动态参数删除

  • 接口地址:/api/v1/editor/creation/dyn/data/delete?token=ACCESS_TOKEN

  • 方法类型:GET

  • 请求参数

    参数名 是否必须 参数类型 参数说明
    creationId 必须 Integer 作品Id
    dataId 必须 String 动态参数id,长度在32位以内。同一个作品可以有多个dataId。在访问作品详情页时携带。
  • 正确时返回:
    {
      "success": true,
      "code": 200,
      "msg": "操作成功"
    }
    
  • 错误时返回:
    {
      "success": false,
      "code": "B000005",
      "msg": "数据不存在"
    }
    

2022年9月5日 15:11 3353 收藏文档