插入图片

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

英飞画布服务端支持基于 Restful API 向画布中插入帧框元素。

前提条件

• 已经完成英飞画布应用的创建动作，详见新人指引文档。
• 了解 REST API 请求的认证方式，详见获取 Access Token 文档。
• 持有创建画布接口返回的画布 ID。

请求路径

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

请求参数

基本参数说明如下：

字段

类型

描述

必填

recordId

string

画布 ID

是

userId

string

元素创建者用户 loginName

是

element

Object

对象数据结构，详情见下方元素信息结构说明

是

元素信息结构说明如下：

字段

类型

描述

必填

position.x

number

元素左上角x坐标

是

position.y

number

元素左上角y坐标

是

size.width

number

元素宽度

是

size.height

number

元素高度

是

name

string

帧框标题

否

hasBg

boolean

帧框是否显示背景

否

请求参数示例

{
  "recordId": "SAMPLE_RECORD_ID",
  "userId": "SAMPLE_USER_LOGIN_NAME",
  "element": {
    "position": {
      "x": 100,
      "y": 100
    },
    "size": {
      "width": 1280,
      "height": 720
    },
    "name": "帧框",
    "hasBg": true
  }
}

请求 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/frames

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

请求成功情况

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

{
  "elementId": "SAMPLE_ELEMENT_ID"
}

请求失败情况

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