メインコンテンツへスキップ
Vantage Mobile Upload は API コールを使用して Vantage サーバーと通信します。これらのコールは、指定した Parameter を用いてドキュメントを作成し、画像をアップロードし、トランザクションの処理を開始するために使用されます。

​
iOS プラットフォーム

Vantage Mobile Input の iOS マイクロアプリケーションは、次の API 呼び出しを使用します:
  1. 入力セッションのパラメーターを Vantage Mobile Upload Backend に送信する
  2. 入力セッションのパラメーターを Vantage Mobile Upload Backend から取得する
  3. トランザクションのステータスを取得する
  4. ドキュメント画像を分析するためのモデルをダウンロードする
  5. トランザクション内の documents の一覧を取得する
  6. トランザクション内の既存の documents を削除する
  7. トランザクション内に Document を作成する
  8. 取得した画像を Document にアップロードする
  9. トランザクションを開始する

​
Android プラットフォーム

Vantage Mobile Input の Android マイクロアプリは、次の API 呼び出しを使用します:
  1. トランザクションのステータス取得
  2. ドキュメント画像を解析するためのモデルのダウンロード
  3. トランザクション内のドキュメント一覧の取得
  4. トランザクション内の既存ドキュメントの削除
  5. トランザクション内でのドキュメントの作成
  6. ドキュメントへの撮影画像のアップロード
  7. トランザクションの開始

​
Vantage Mobile Upload Backend への入力セッション Parameter の送信

ユーザーがいつ、どのデバイスからドキュメントの取り込みを開始したかを記録するには、POST /api/mobileinputbackend/v1/inputsessions を使用します。 このリソースは次の Parameter を受け付けます。

​
入力セッションのパラメーター

ParameterTypeDescription
transactionIdstring (uuid)必須。モバイルアップロードリンクで指定されたトランザクションの識別子。
platformstring必須。マイクロアプリケーションを開いているデバイスのモバイルプラットフォーム。取り得る値: iOS、Android、Web。
deviceModelstring任意。マイクロアプリケーションを開いているデバイスのモデル。
OSVersionstring任意。マイクロアプリケーションを開いているデバイスのOSバージョン。
MIVersionstring任意。デバイスで開かれている Vantage Mobile Input のバージョン。

​
Vantage Mobile Upload Backend から入力セッションのパラメータを取得する

ユーザーがドキュメントのキャプチャを開始した時刻を確認するには、GET /api/mobileinputbackend/v1/inputsessions/{transactionId} を使用します。 このリソースは次のパラメータを返します：

​
入力セッションのパラメーター

ParameterTypeDescription
transactionIdstring (uuid)モバイルアップロードリンクで指定されたトランザクション識別子。
platformstringマイクロアプリが開かれているデバイスのモバイルプラットフォーム。可能な値：iOS、Android、Web。
deviceModelstringマイクロアプリが開かれているデバイスのモデル。
OSVersionstringマイクロアプリが開かれているデバイスのOSバージョン。
MIVersionstringデバイスで開かれている Vantage Mobile Input のバージョン。
createdAtstring (date-time)入力セッションの作成日時。

​
トランザクションのステータスを取得する

ドキュメントを取り込み・アップロードする際にトランザクションの現在のステータスを確認するには、GET /api/publicapi/v1/transactions/{transactionId} を使用します。 このリソースは、次の情報を含むトランザクションの詳細を返します。
  • transactionId：トランザクションの一意の識別子
  • status：現在のトランザクションのステータス（New、Queued、InProgress、Processed など）
  • createdAt：トランザクションの作成日時
  • documents：トランザクション内のドキュメントの配列

​
文書画像を解析するためのモデルのダウンロード

文書画像の品質や種類の検出を行う機械学習モデルをダウンロードするには、GET /api/mobileinputbackend/v1/models を使用します。 このエンドポイントは、モバイルアプリ向けに次のモデルを提供します:
  • 文書の境界を検出する
  • 画像の品質をチェックする
  • 文書の種類を識別する
  • 取得した画像を検証する

​
トランザクション内のドキュメント一覧を取得する

現在そのトランザクションに関連付けられているすべてのドキュメントを取得するには、GET /api/publicapi/v1/transactions/{transactionId}/documents を使用します。 このリソースはドキュメントオブジェクトの配列を返し、各オブジェクトには次が含まれます:
  • id：ドキュメント識別子
  • name：ドキュメント名
  • status：ドキュメントの処理ステータス
  • files：ドキュメントに関連付けられたファイル（画像）の配列

​
トランザクション内の既存ドキュメントの削除

処理を開始する前にトランザクションからドキュメントを削除するには、DELETE /api/publicapi/v1/transactions/{transactionId}/documents/{documentId} を使用します。 これにより、ユーザーは次のことが可能になります:
  • 誤って取り込まれたドキュメントを削除する
  • 再取り込み前にドキュメントを消去する
  • トランザクション内のドキュメントセットを管理する
注: ドキュメントは、トランザクションの処理開始前にのみ削除できます。

​
トランザクションでドキュメントを作成する

画像をアップロードするためにトランザクション内に新規ドキュメントを作成するには、POST /api/publicapi/v1/transactions/{transactionId}/documents を使用します。 リクエストボディの例： 
{
  "documents": [
    {
      "name": "Invoice",
      "index": 0
    }
  ]
}
これにより、画像のアップロードに使用する Document ID が返されます。

​
取得した画像をドキュメントへアップロードする

特定のドキュメントに取得した画像をアップロードするには、POST /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}/sourceFiles を使用します。 リクエストには次を含める必要があります:
  • 画像ファイルのフォームデータ
  • 各ファイルに関する任意のメタデータ
  • 画像処理オプション（autoCrop、autoOrientation）
リクエスト形式: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Files=@image1.jpg;type=image/jpeg" \
-F "Files=@image2.jpg;type=image/jpeg"

​
トランザクションの開始

トランザクション内のアップロード済みのすべてのドキュメントの処理を開始するには、POST /api/publicapi/v1/transactions/{transactionId}/start を使用します。 この操作により、トランザクション作成時に指定した Skill を使用して処理ワークフローが開始されます。 リクエスト例: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/start" \
-H "Authorization: Bearer token"
開始後:
  • トランザクションのステータスは Queued または InProgress に変更されます
  • Documents は設定済みの Skill に従って処理されます
  • ステータスが Processed に達すると結果を利用可能になります
  • トランザクションのステータス用エンドポイントで進捗を追跡できます