本文通过示例说明如何快速通过API接入Docflow工作流。
但如果您没有在Web UI上使用过Docflow,建议您先在Web页面上传文件直观体验一下Docflow的工作方式。

01 先决条件:获取访问凭证

1.1 公有云使用

使用Docflow API时,您需要先获取API Key。
请先登录后前往 TextIn工作台 - 账号与开发者信息 获取您的x-ti-app-idx-ti-secret-code

1.2 私有云使用

请联系对接的技术支持人员,获取用于私有化部署的API调用凭证。

02 前置准备

2.1 配置Docflow空间与分类

先参考获取工作空间ID配置文件类别文档,完成配置,获取工作空间ID。

2.2 上传文件

示例:
curl \
  -H "x-ti-app-id: <your-app-id>" \
  -H "x-ti-secret-code: <your-secret-code>" \
  -F file=@</path/to/your/file.pdf \
  "https://docflow.textin.com/api/app-api/sip/platform/v2/file/upload?workspace_id=<your-workspace-id>"
使用您的参数执行上面示例代码后,可以在 Web 页面对应空间下查看刚上传的文件。

2.3 结果获取

示例:
curl \
  -H "x-ti-app-id: <your-app-id>" \
  -H "x-ti-secret-code: <your-secret-code>" \
  "https://docflow.textin.com/api/app-api/sip/platform/v2/file/fetch?workspace_id=<your-workspace-id>"

2.4 结果解析

获取到的结果是JSON格式的文档处理后的结果,可以通过解析JSON获取文档解析、分类、抽取后的结果。
下面示例是输出文档字段抽取结果,其他信息的解析可以参考其余文档章节。
# 接续《结果获取》的示例代码

for file in resp_json["result"]["files"]:
  for item in file["data"]["items"]:
    print(f"{item["key"]}: {item["value"]}")