跳到主要内容

插入图片

更新时间 2025/02/22 07:19:43

英飞画布服务端支持基于 Restful API 往画布中插入图片作为元素。

前提条件​

请求路径​

https://developer.infi.cn/infi/api/v1/boards/images

请求参数​

基本参数说明如下：

字段
类型
描述
必填
recordId
string
画布 ID
是
userId
string
元素创建者用户 loginName
是
element
Object
对象数据结构，详情见下方元素信息结构说明
是

元素信息结构说明如下：

字段
类型
描述
必填
picUrl
string
图片公开链接
是
imageType
1/2/3
图片类型，详情见下方说明
是
position.x
number
图片左上角x坐标
是
position.y
number
图片左上角y坐标
是
size.width
number
图片宽度
是
size.height
number
图片高度
是
scale
number
图片缩放比例
是
zIndex
number
元素层级，值为正整数
是
name
string
图片元素名称
否
frameId
string
从属帧框的 ID
否

说明：

  • imageType 图片类型：1 代表 jpg 格式图片；2 代表 gif 格式图片；3 代表 png 格式图片。注：请确保该值代表类型，与待插入图片的类型保持一致。
  • zIndex 值会影响到元素见的层级关系，位置相近的情况下，较小 zIndex 的元素很可能会被较大 zIndex 的元素覆盖。

请求参数示例​

{
  "recordId": "SAMPLE_RECORD_ID",
  "userId": "SAMPLE_USER_LOGIN_NAME",
  "element": {
    "position": {
      "x": 100,
      "y": 100
    },
    "size": {
      "width": 1280,
      "height": 720
    },
    "name": "SAMPLE_PIC_NAME.png",
    "fileType": 3,
    "picUrl": "SAMPLE_PIC_URL",
    "scale": 1,
    "zIndex": 10
  }
}

请求 curl 示例​

curl --location --request POST \
      --header 'token: YOUR_ACCESS_TOKEN' \
      --header 'Content-Type: application/json' \
      --data '{ PAYLOADS_HERE }' \
      https://developer.infi.cn/infi/api/v1/boards/images

注意：请确保将 PAYLOADS_HERE 替换为请求参数中列举的数据。

请求成功情况​

响应的 Http 状态码为 200 时表示请求成功，并会带有新创建图片元素的 ID。 请求成功返回数据示例如下:

{
  "elementId": "SAMPLE_ELEMENT_ID"
}

请求失败情况​

响应的 Http 状态码不为 200 时表示请求失败，如需更多信息请参考请求错误说明文档。