跳转到主要内容
使用单个 API 调用(用于创建事务、上传文件并启动该事务)来处理文档的典型场景包括以下步骤:
  1. 获取所有可用技能的列表。
  2. 创建并启动一个事务。
  3. 监控事务状态。
  4. 下载源文件和结果文件。
发送到服务器的每个请求都必须包含身份验证信息。有关更多信息,请参见 Authentication 如果您只有一个大小小于 30 MB 的文件,并且不需要对该文件的图像进行编辑,请使用此场景。

步骤 1. 获取所有可用技能列表

要获取所有可用技能列表,请向 skills 资源发送 GET 请求: 运行以下命令: 执行后,您将收到有关已添加到该应用实例的所有技能的信息。

步骤 2. 创建并启动事务

要创建并启动事务,请向 transactions/launch 资源发送 POST 请求: 在 URL 中指定 skillId 查询参数(由上一个 API 调用返回)。在请求体中发送要处理的文件以及可选的元数据。你还可以在请求体中传递可选的 registrationParametersskillParameters 下面是一个请求体示例:
{
  "files": [
    {
    }
  ]
}
运行以下命令: 执行后,您将收到一条响应,其中包含已创建事务的 id

步骤 3:监控事务状态

要监控事务状态,请向 transactions 资源发送 GET 请求: 运行以下命令: 随后,您将收到一个包含事务状态的响应。事务处理状态可能为以下之一:
  • New。事务已创建,但尚未加入处理队列。
  • Queued。事务已加入处理队列。
  • InProgress。事务正在处理中。
  • Processed。事务已成功处理。
  • ProcessedWithWarnings。事务已处理完成,但过程中出现警告。
  • NotProcessed。事务由于错误未处理。
  • Deleted。事务被用户或根据保留策略自动删除。
如果事务状态为 ProcessedProcessedWithWarnings,请继续执行步骤 4。

步骤 4. 下载源文件和结果文件

要下载源文件和结果文件,请向 transactions/files/download 资源发送 GET 请求,其中需要指定在上一个请求中获取的文件 ID: 运行以下命令: