このページでは、API で DocFlow ワークフローをすばやく連携するための例を紹介します。
Web UI で DocFlow をまだ利用したことがない場合は、まず Web ページ でファイルをアップロードし、DocFlow の動作を確認することをおすすめします。 01 前提条件: アクセス認証情報を取得
1.1 パブリッククラウドでの利用
Docflow API を利用するには、まず API Key を取得する必要があります。
ログイン後、TextIn コンソール - アカウントと開発者情報 で x-ti-app-id と x-ti-secret-code を取得してください。
1.2 プライベートクラウドでの利用
プライベートデプロイ用の API 呼び出し認証情報は、担当のテクニカルサポートにお問い合わせください。
02 準備
2.1 Docflow ワークスペースと分類を設定
まず Workspace 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.ai/api/app-api/sip/platform/v2/file/upload?workspace_id=<your-workspace-id>"
2.3 結果を取得
例:
curl \
-H "x-ti-app-id: <your-app-id>" \
-H "x-ti-secret-code: <your-secret-code>" \
"https://docflow.textin.ai/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']}")
