创建画布

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

英飞画布服务端支持基于 Restful API 直接创建一块画布，并反馈画布的 ID 信息。

前提条件

• 已经完成英飞画布应用的创建动作，并获取到应用对应的 appId 和 appSecret
• 了解 Restful API 请求签名的生成方式（详见生成签名）

Http 请求

• 请求路径：

https://api.infi.cn/u3wbs/wbs/websdk/createBoard

• 请求参数

字段

类型

描述

appId

string

应用 appId，可以在控制台中获取

expire

integer

签名过期时间戳（毫秒）

creatorId

string

创建者 id，值由调用方决定，在英飞侧没有业务属性，仅作标记用

signature

string

签名，生成方式见链接

请求参数示例：

appId=test&expire=12345678901234&creatorId=test&signature=70D59A285EE91C666020FB3D0359FBAAA1867145

请求的参数连同请求签名需要以 Url Search Params 形式拼接至接口路径之后。

• 完整请求 curl 示例:

curl --location --request POST 'https://api.infi.cn/u3wbs/wbs/websdk/createBoard?appId=test&expire=12345678901234&creatorId=test&signature=70D59A285EE91C666020FB3D0359FBAAA1867145'

• 响应包体

  • 请求成功情况 如果请求成功，则响应的数据内状态码为 0，并会带有新创建画布的 recordId（即 uuid） 请求成功包体示例：

{
  "code": 0,
  "reqId": "string",
  "reqTime": 0,
  "obj": {
    "recordId": "string"
  }
}

• 请求失败情况 响应包体中 code 字段不为 0 时表请求失败，失败信息请查询错误码列表。