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

​
iOS 平台

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

​
Android 平台

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

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

要记录用户开始捕获文档的时间以及所用设备，请使用 POST /api/mobileinputbackend/v1/inputsessions。 此资源接受以下参数：

​
输入会话参数

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

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

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

​
输入会话参数

ParameterType描述
transactionIdstring (uuid)在移动端上传链接中指定的事务（Transaction）标识符。
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：Document 标识符
  • name：Document 名称
  • status：Document 处理状态
  • files：与该文档关联的文件（图像）数组

​
在处理事务中删除现有文档

要在开始处理之前从处理事务中删除文档，请使用 DELETE /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}。 这样可以让用户：
  • 删除错误捕获的文档
  • 在重新捕获前清空文档
  • 在处理事务中管理文档集
注意： 只能在处理事务开始之前删除文档。

​
在处理事务中创建文档

要在处理事务中创建用于上传图像的新文档，请使用 POST /api/publicapi/v1/transactions/{transactionId}/documents。 请求正文示例： 
{
  "documents": [
    {
      "name": "发票",
      "index": 0
    }
  ]
}
这将返回一个用于上传图像的 Document ID。

​
将采集的图像上传到文档

要将采集的图像上传到特定文档，请使用 POST /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}/sourceFiles。 请求必须包含：
  • 含图像文件的表单数据
  • 每个文件的可选元数据
  • 图像处理选项（autoCrop、autoOrientation）
请求格式： 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Files=@image1.jpg;type=image/jpeg" \
-F "Files=@image2.jpg;type=image/jpeg"

​
启动处理事务

要开始处理该处理事务中所有已上传的文档，请使用 POST /api/publicapi/v1/transactions/{transactionId}/start。 这将以创建该处理事务时指定的 Skill 启动处理工作流。 请求示例： 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/start" \
-H "Authorization: Bearer token"
启动后：
  • 处理事务状态将变为 Queued 或 InProgress
  • 系统将按已配置的 Skill 处理文档
  • 当状态变为 Processed 时，结果可用
  • 你可以使用处理事务状态端点来跟踪进度