跳转到主要内容
使用单独的 API 调用来处理文档(分别用于创建事务、上传文件和启动事务)的典型场景包括以下步骤:
  1. 获取所有可用技能的列表
  2. 创建一个空事务
  3. 向事务中添加要处理的一组文件
  4. 启动事务
  5. 监控事务状态
  6. 下载源文件和结果文件
发送到服务器的每个请求都必须包含身份验证信息(例如访问令牌)。有关详细信息,请参阅身份验证

获取所有可用技能的列表

为此,请向 skills 资源发送 GET 请求: 运行以下命令: 这样,您将收到有关已添加到应用程序实例的所有技能的信息。

创建空事务

为此,请向 transactions 资源发送以下 POST 请求: 运行以下命令: 在请求体中指定由上一个 API 调用返回的 skillId Parameter。请求成功后,您将收到一个响应,其中包含已创建事务的 id

在事务中添加要处理的一组文件

重要! 一个事务中最多可以包含 1000 个文件。 可以通过两种方式添加一组文件:

直接向事务添加文件

为此,请向 transactions/<transaction-id>/files 资源发送 POST 请求: 运行以下命令: 这样,您将收到一个包含已添加文件及其标识符的响应。您可以通过多次重复此调用来添加任意数量的文件。 上传文件的其他选项:

向文档添加文件

首先,通过向 transactions/<transaction-id>/documents 资源发送 POST 请求来创建一个文档: 请求成功后,您将收到包含文档标识符的响应。 然后,通过向 transactions/<transaction-id>/documents/<document-id>/sourceFiles 资源发送 POST 请求,将文件添加到该文档中:

启动事务

要使用指定的技能和文件启动事务,请向 transactions/<transaction-id>/start 资源发送如下 POST 请求:

监控事务状态

要开始通过带有较短超时时长的循环来监控事务状态(我们不建议检查状态的频率超过每秒一次),请向 transactions/<transaction_id> 资源发送一个 GET 请求,并在请求 URI 中包含事务标识符: 您将收到一个包含事务状态的响应。事务处理可能处于以下状态之一:
  • New。事务已创建,但尚未加入处理队列。
  • Queued。事务已加入处理队列。
  • InProgress。事务正在处理。
  • Processed。事务已成功处理。
  • ProcessedWithWarnings。事务已处理,但出现了警告。
  • NotProcessed。由于错误,事务未被处理。
  • Deleted。事务被用户或由保留策略自动删除。
如果事务状态为 ProcessedProcessedWithWarnings,请转到步骤 6。

下载源文件

要获取包含文档标识符的文档列表,请向 transactions/<transaction-id>/documents 资源发送 GET 请求,并指定事务标识符: 请求成功后,系统将返回在该事务中创建的所有文档的列表。响应还包含这些文档的标识符,可用于请求特定文档的详细信息。 要获取添加到特定文档的文件列表,请向 transactions/<transaction-id>/documents/<document-id> 资源发送 GET 请求: 请求成功后,您将获得该文档的相关信息。响应还包含添加到该文档的文件标识符。 要下载源文件,请向 transactions/<transaction-id>/files/<file-id>/download 资源发送 GET 请求: