跳到主要内容

画布预置文档类型元素

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

英飞画布服务端支持基于 Restful API 往画布中预置文档元素

前提条件

  • 获取到应用对应的 appId 和 appSecret
  • 获取到提前创建好的画布的 recordId (创建画布)
  • 获取到预解析回调提供的fileId (文档预解析)
  • 了解 Restful API 请求签名的生成方式 (生成签名)

Http 请求

  • 请求路径:
https://api.infi.cn/u3wbs/wbs/websdk/addElem
  • 请求参数Query
字段
类型
描述
appId
string
应用 appId,可以在控制台中获取
expire
integer
签名过期时间戳(毫秒)
recordId
string
画布 recordId,即创建画布时返回的 recordId
userId
string
创建者Id
signature
string
签名,生成方式见链接

请求参数示例:

appId=test&expire=12345678901234&recordId=12345678901234&userId=lzl&signature=70D59A285EE91C666020FB3D0359FBAAA1867145

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

  • 请求参数Body
字段
类型
描述
是否必填
elemType
integer
元素类型,目前仅支持8:文档
position
object
预置元素的坐标
position.x
integer
元素左上角x坐标
position.y
integer
元素左上角y坐标
fileType
integer
1.pdf 2.ppt 3.excel 4.word
fileId
string
预解析文件ID
name
string
文件名称
size
object
放置大小
size.width
integer
文档宽度
size.height
integer
文档高度
titleHeight
integer
标题宽度
totalPage
integer
总页数
scale
integer
缩放比例 计算出来的值,scale = 900/maxwh,(maxwh是宽高里面的较大值)

请求参数示例:

{
"elemType": 8,
"position": {
"x": 1234.1234,
"y": 1234.1234
},
"fileType": 1,
"fileId": "// 来自文档处理 - 预解析",
"name": "// 来自文档处理 - 预解析",
"size": {
"width": 1280,
"height": 720
},
"titleHeight": 0,
"scale": 1,
"totalPage": "// 来自文档处理 - 预解析",
"deleted": false
}
  • 请求返回体
字段
类型
描述
code
integer
0表示成功,其他表示失败
reqId
string
请求id
reqTime
integer
请求时间戳
obj
object
解析结果
obj.elementId
string
元素ID

返回体示例:

{
"code": 0,
"reqId": "12345678901234",
"reqTime": 12345678901234,
"obj": {
"elementId": "aaaabbbbccccdddd"
}
}
  • 请求失败情况 响应包体中 code 字段不为 0 时表请求失败,失败信息请查询错误码列表