跳到主要内容

调用流程

调用的模式

文档中台服务端API主要是处理文件的格式和内容,比如转版API可以把Word文件转成pdf文件,比如内容处理API可以给Word文件添加内容水印。一般的调用方式是:

  1. 业务系统服务端调用Filez文档中台服务端Open API。调用时传递需要处理的文件的下载地址和处理完成时的通知地址。

  2. 文档中台服务端收到请求,验证通过后,文档中台服务端内部创建一个任务开始处理,同时立即把相关信息返回给业务系统调用方。

  3. 文档中台服务端在处理任务时,根据API调用时提供的文件下载地址,从业务系统下载文件。

  4. 文档中台服务端获取文件并成功处理完,根据API调用时提供的通知地址,通知业务系统下载文件。

  5. 业务系统根据文档中台的通知信息,从文档中台下载结果文件,完成调用。

    image-20231222140350212

异步方式

当三方系统调用中台的转换接口时,中台会立即记录请求并生成相应的任务。随后,中台会返回一个任务ID给三方系统。

在任务完成后,中台将主动调用三方系统提供的回调接口,通知任务的最终结果。

若任务成功完成,通知中将包含结果文件的相关信息;而若任务失败,通知中则会包含失败的详细原因。

这种异步设计的优势在于:

  1. 提高系统的响应速度: 由于请求和任务处理是异步进行的,调用方无需等待任务完成,而是可以继续执行其他操作,提高了系统的整体响应速度。

  2. 提高系统的可扩展性: 异步设计允许系统更好地适应高并发情境,因为它不会在每个请求都完成时才返回,从而避免了阻塞问题。

  3. 增强用户体验: 用户无需长时间等待操作完成,异步调用允许他们更快地得到反馈,并且可以在等待的过程中继续进行其他操作。

同步方式的模拟

文档中台提供任务状态查询API。业务系统通过循环调用任务状态查询API,可以实现类似同步调用效果。

image-20231222140350212

  1. 业务系统服务端调用Filez文档中台服务端Open API。调用时传递需要处理的文件的下载地址和处理完成时的通知地址。
  2. 文档中台服务端收到请求,验证通过后,文档中台服务端内部创建一个任务开始处理,同时立即把相关信息返回给业务系统调用方。
  3. 业务系统间隔一定时间后(至少200ms),查询任务的状态。
  4. 文档中台根据任务的状态,返回任务当前的状态,比如:正在等待中。
  5. 文档中台开始处理该任务,根据API调用时提供的文件下载地址,从业务系统下载文件。
  6. 业务系统间隔一定时间后(至少200ms),查询任务的状态。
  7. 文档中台根据任务的状态,返回任务当前的状态,比如:任务成功完成,并提供下载结果的信息。
  8. 业务系统根据下载结果的信息,从文档中台下载结果文件,完成调用。