跳到主要内容

插入图片

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

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

注：当前仅支持基于 API 插入空白便签，我们将在未来的版本中逐步引入对于便签文本内容的支持。

前提条件​

请求路径​

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

请求参数​

基本参数说明如下：

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

元素信息结构说明如下：

字段
类型
描述
必填
position.x
number
元素左上角x坐标
是
position.y
number
元素左上角y坐标
是
scale
number
便签缩放值，会直接影响便签的大小
是
color
string
便签颜色, 字段值请参考下方说明
是
zIndex
number
元素层级，值为正整数
是
showAuthor
boolean
便签是否默认显示作者
否
shape
0/1
便签形状：0 代表正方形，1 代表长方形, 默认为 0
否
frameId
string
从属帧框 ID
否

说明：

  • 便签颜色当前仅支持以下字段： 0xf5f6f8, 0xfff9b1, 0xd5f692, 0xf5d128, 0xc9df56, 0xff9d48, 0x93d275, 0xf16c7f, 0x67c6c0, 0xea94bb, 0x6cd8fa, 0xffcedf, 0xa6ccf5, 0xbe88c7, 0x7b92ff, 0x7da6ed。
  • zIndex 值会影响到元素见的层级关系，位置相近的情况下，较小 zIndex 的元素很可能会被较大 zIndex 的元素覆盖。

请求参数示例​

{
  "recordId": "SAMPLE_RECORD_ID",
  "userId": "SAMPLE_USER_LOGIN_NAME",
  "element": {
    "position": {
      "x": 100,
      "y": 100
    },
    "scale": 1,
    "color": "0xf5f6f8",
    "shape": 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/notes

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

请求成功情况​

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

{
  "elementId": "SAMPLE_ELEMENT_ID"
}

请求失败情况​

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