文档预解析

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

英飞画布服务端支持基于 Restful API 提前发起文档预解析请求，支持的文档类型有ppt,word,excel,pdf。

前提条件

获取到应用对应的 appId 和 appSecret
提供解析完成的回调地址，用于接收解析结果，并根据结果做进一步调用
了解 Restful API 请求签名的生成方式（详见生成签名）

解析注意事项

解析的文档不建议大于 500M 存在较大失败概率
解析接口会针对文档页码进行实时解析，因此服务端调用时设置接口超时时间应该大于 30s,建议为 60s

Http 请求

请求路径：

https://api.infi.cn/u3wbs/wbs/websdk/doc/commonParse

请求参数 Query

字段

类型

描述

必填

appId

string

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

是

expire

integer

签名过期时间戳（毫秒）

是

signature

string

签名，生成方式见链接

是

userId

string

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

是

请求参数示例：

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

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

请求参数 Body

字段

类型

描述

必填

docFileUrl

string

文档的下载地址

是

callbackUrl

string

解析完成的回调地址

是

fileType

integer

文档类型 1.pdf 2.ppt 3.excel 4.word

是

请求参数示例：

{
  "docFileUrl": "DOC_FILE_URL",
  "callbackUrl": "CALLBACK_URL"
}

请求返回体

字段

类型

描述

code

integer

0 表示成功，其他表示失败

reqId

string

请求 id

reqTime

integer

请求时间戳

obj

object

解析结果

obj.taskId

string

解析任务 ID

obj.fileId

string

文档 ID,后续用于预置文档到白板中

obj.totalPage

string

文档总页数

obj.coverWidth

string

封面宽度

obj.coverHeight

string

封面高度

请求返回示例

{
  "code": 0,
  "reqId": "req1",
  "reqTime": 1703488288299,
  "obj": {
    "taskId": "65892b2d3c2f2c20a4ce5a46",
    "fileId": "65892b216c82e20001c044c1",
    "totalPage": 2,
    "coverWidth": 5120,
    "coverHeight": 2880
  }
}

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

前提条件​

解析注意事项​

Http 请求​

前提条件

解析注意事项

Http 请求