跳转到主要内容
Vantage Mobile Upload 通过 API 调用与 Vantage 服务器通信。这些调用用于创建文档、上传图像，并以特定参数启动事务处理。

​
iOS 平台

Vantage Mobile Input 的 iOS 微应用使用以下 API 调用：
  1. 将输入会话参数发送到 Vantage Mobile Upload Backend
  2. 从 Vantage Mobile Upload Backend 获取输入会话参数
  3. 获取事务状态
  4. 下载用于分析文档图像的模型
  5. 获取事务中的文档列表
  6. 删除事务中的现有文档
  7. 在事务中创建文档
  8. 将拍摄的图像上传到文档
  9. 启动事务

​
Android 平台

Vantage Mobile Input 的 Android 微型应用使用以下 API 调用：
  1. 获取事务的状态
  2. 下载用于对文档图像进行分析的模型
  3. 获取该事务中的文档列表
  4. 删除该事务中的现有文档
  5. 在该事务中创建文档
  6. 将采集的图像上传到文档中
  7. 启动该事务

​
向 Vantage Mobile Upload Backend 发送输入会话参数

若要记录用户何时开始采集文档以及来自哪台设备，请使用 POST /api/mobileinputbackend/v1/inputsessions。 此资源接受以下参数：

​
输入会话参数

ParameterTypeDescription
transactionIdstring (uuid)必填。在移动上传链接中指定的事务标识符。
platformstring必填。打开微应用的设备所属的移动平台。可能的取值：iOS、Android、Web。
deviceModelstring可选。打开微应用的设备型号。
OSVersionstring可选。打开微应用的设备操作系统版本。
MIVersionstring可选。在该设备上打开的 Vantage Mobile Input 的版本。

​
从 Vantage Mobile Upload Backend 获取输入会话参数

要查看用户何时开始采集文档，请使用 GET /api/mobileinputbackend/v1/inputsessions/{transactionId}。 此资源会返回以下参数：

​
输入会话参数

ParameterTypeDescription
transactionIdstring (uuid)在移动上传链接中指定的事务标识符。
platformstring打开该微应用的设备所使用的移动平台。可能的取值：iOS、Android、Web。
deviceModelstring打开该微应用的设备型号。
OSVersionstring打开该微应用的设备操作系统版本。
MIVersionstring在设备上打开的 Vantage Mobile Input 的版本。
createdAtstring (date-time)输入会话创建时的日期和时间。

​
获取事务状态

在捕获并上传文档时，如需检查事务的当前状态，请使用 GET /api/publicapi/v1/transactions/{transactionId}。 此资源会返回有关该事务的信息，包括：
  • transactionId：事务的唯一标识符
  • status：当前事务状态（New、Queued、InProgress、Processed 等）
  • createdAt：事务的创建时间
  • documents：事务中的文档数组

​
下载用于分析文档图像的模型

要下载用于检测文档图像质量和类型的机器学习模型，请使用 GET /api/mobileinputbackend/v1/models。 该端点提供的模型可帮助移动应用程序：
  • 检测文档边界
  • 检查图像质量
  • 识别文档类型
  • 校验采集的图像

​
获取事务中的文档列表

要获取当前与事务关联的所有文档，请使用 GET /api/publicapi/v1/transactions/{transactionId}/documents。 该接口返回一个文档对象数组，其中每个对象包含：
  • id。文档标识符
  • name。文档名称
  • status。文档处理状态
  • files。与文档关联的文件（图像）数组

​
在事务中删除已有文档

要在开始处理之前从事务中移除某个文档，请使用 DELETE /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}。 通过此操作，用户可以：
  • 移除采集错误的文档
  • 在重新采集前先删除文档
  • 管理事务中的文档集合
注意： 只能在事务开始处理之前删除文档。

​
在事务中创建文档

要在该事务中创建一个用于上传图像的新文档，请使用 POST /api/publicapi/v1/transactions/{transactionId}/documents。 请求体示例： 
{
  "documents": [
    {
      "name": "Invoice",
      "index": 0
    }
  ]
}
这将返回一个文档 ID，供后续上传图像时使用。

​
将捕获的图像上传到文档

要将捕获的图像上传到特定文档，请使用 POST /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}/sourceFiles。 请求中应包括：
  • 含有图像文件的表单数据
  • （可选）每个文件的元数据
  • 图像处理选项（autoCrop、autoOrientation）
请求格式：

​
启动事务

要开始处理事务中已上传的所有文档，请使用 POST /api/publicapi/v1/transactions/{transactionId}/start。 这将使用创建事务时指定的技能启动处理工作流。 请求示例： 启动后：
  • 事务状态会变为 Queued 或 InProgress
  • 文档将按照已配置的技能进行处理
  • 当状态变为 Processed 时，即可获取处理结果
  • 可以通过事务状态接口跟踪处理进度