Vantage Mobile Upload は、API 呼び出しを使用して Vantage サーバーと通信します。これらの呼び出しは、documents の作成、画像のアップロード、特定のパラメーターによるトランザクション処理の開始に使用されます。
Vantage Mobile Input の iOS マイクロアプリケーションは、次の API 呼び出しを使用します:
- 入力セッションのパラメーターを Vantage Mobile Upload Backend に送信する
- 入力セッションのパラメーターを Vantage Mobile Upload Backend から取得する
- トランザクションのステータスを取得する
- ドキュメント画像を分析するためのモデルをダウンロードする
- トランザクション内の documents の一覧を取得する
- トランザクション内の既存の documents を削除する
- トランザクション内に Document を作成する
- 取得した画像を Document にアップロードする
- トランザクションを開始する
Vantage Mobile Input の Android マイクロアプリは、次の API 呼び出しを使用します:
- トランザクションのステータス取得
- ドキュメント画像を解析するためのモデルのダウンロード
- トランザクション内のドキュメント一覧の取得
- トランザクション内の既存ドキュメントの削除
- トランザクション内でのドキュメントの作成
- ドキュメントへの撮影画像のアップロード
- トランザクションの開始
Vantage Mobile Input は、入力セッション Parameter を Vantage Mobile Upload Backend に送信します。これらの Parameter は、Android のマイクロアプリケーションまたは Web ブラウザーでのアップロードセッションに使用されます。
| Key | Description |
|---|
| BaseURL | Vantage server のメインドメイン。 |
| TransactionID | トランザクションの識別子。 |
| Token | Vantage API への認証済みアクセスに使用される、エンコードされた access token。 |
| v | Vantage API のバージョン。 |
| md | 1 つのトランザクションで抽出される文書数。 |
| redirect_uri | Vantage Mobile Upload の完了後に開くリダイレクトリンク。 |
| dt | 文書タイプ。 |
| ma | オンプレミス環境で micro applications を起動するために使用される、ABBYY Vantage クラウド環境のアドレス。 |
| キー | 説明 |
|---|
| BaseURL | Vantage serverのメインドメインです。 |
| TransactionID | トランザクションの識別子です。 |
| Token | Vantage API への認証済みアクセスに使用される、エンコードされたアクセス トークンです。 |
| v | Vantage API のバージョンです。 |
| md | 1 つのトランザクションで取り込まれる文書数です。 |
| redirect_uri | Vantage Mobile Upload の完了後に開くリダイレクト先のリンクです。 |
| dt | 文書タイプです。 |
| ma | オンプレミス環境でマイクロアプリケーションを開始するために使用される、ABBYY Vantage クラウド環境のアドレスです。 |
| キー | 説明 |
|---|
| TransactionID | トランザクションの識別子です。 |
| Status | トランザクションのステータスです。使用できる値: New, Started, Processing, Processed |
| キー | 説明 |
|---|
| AbbyyRtrSDK-version | 関連するパターンファイルのリクエストに使用する AbbyyRtrSDK フレームワークのバージョンです。値は Vantage のバージョンに応じて変わる場合があります。 |
| PatternFileName | 文書画像内のページの端を検出するために使用される AbbyyRtrSDK のファイルパターン名です。ファイルパターンには 6 種類あります: FactCrop.imodel, CnnCrop.Classifier.cnnmodel, DIQClassifier.imodel, CnnCrop.Detector.GenericWithID.cnnmodel, DIQBlockClassifier.imodel, CropClassifierPhoto.imodel |
| キー | 説明 |
|---|
| TransactionID | トランザクションの識別子です。 |
| DocumentID | Creating a document リクエストで取得したドキュメントの識別子です。 |
| SourceFileID | 文書画像の識別子です。 |
| SourceFileName | 文書画像の名前です。Vantage Mobile Upload は各画像のファイル名を自動生成し、Uploading Images to the document リクエストを使用してその画像をドキュメントにアップロードします。 |
DELETE /api/publicapi/v1/transactions/{transactionId}/documents/{documentId} を使用します。
これにより、ユーザーは次のことが可能になります:
- 誤って取り込まれたdocumentsを削除する
- 再取り込み前にdocumentsを消去する
- トランザクション内のdocumentsセットを管理する
documentsは、トランザクションの処理開始前にのみ削除できます。
| Key | Description |
|---|
| Token | Vantage API への認証済みアクセスに使用する、エンコードされたアクセストークン。 |
| TransactionID | トランザクションの識別子。 |
| DocumentID | ドキュメントの識別子。 |
| キー | 説明 |
|---|
| Token | Vantage API への認証済みアクセスに使用する、エンコードされたアクセストークン。 |
| TransactionID | トランザクションの識別子。 |
| DocumentID | Creating a document リクエストで受け取った文書の識別子。 |
| SourceFileID | 文書画像の識別子。 |
| SourceFileName | 文書画像の名前。Vantage Mobile Upload は各画像のファイル名を自動生成し、画像を文書にアップロードします。 |
| ImageData | 画像ファイルのエンコードされたデータ。文書に画像をアップロードするために使用されます。 |
| Key | 説明 |
|---|
| Token | Vantage API への認証済みアクセスに使用される、エンコードされた認可アクセストークン。 |
| TransactionID | トランザクションの識別子。 |
