Vantage Mobile Input によって処理されるデータ

Vantage Mobile Upload は、API 呼び出しを使用して Vantage server と通信します。これらの呼び出しは、documents の作成、画像のアップロード、特定のパラメーターによるトランザクション処理の開始に使用されます。

プラットフォーム別の API 呼び出し

iOS プラットフォーム

Vantage Mobile Input の iOS マイクロアプリケーションは、次の API 呼び出しを使用します:

入力セッションのパラメーターを Vantage Mobile Upload Backend に送信する
入力セッションのパラメーターを Vantage Mobile Upload Backend から取得する
トランザクションのステータスを取得する
ドキュメント画像を分析するためのモデルをダウンロードする
トランザクション内の documents の一覧を取得する
トランザクション内の既存の documents を削除する
トランザクション内に Document を作成する
取得した画像を Document にアップロードする
トランザクションを開始する

Android プラットフォーム

Vantage Mobile Input の Android マイクロアプリは、次の API 呼び出しを使用します:

トランザクションのステータス取得
ドキュメント画像を解析するためのモデルのダウンロード
トランザクション内のドキュメント一覧の取得
トランザクション内の既存ドキュメントの削除
トランザクション内でのドキュメントの作成
ドキュメントへの撮影画像のアップロード
トランザクションの開始

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

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 クラウド環境のアドレス。

リクエスト:

curl -X POST "https://mobilesessionmanager-eu.abbyy.com/api/v1/mobilesessions"
-H "accept: text/plain" \
-H "Content-Type: application/json" \
-F "Body=
    {
      "sessionAuxiliaryKey": "string",
      "sessionData": "string"
    }

レスポンス:

リクエストのステータスコード

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

入力セッションのパラメータを取得するため、Vantage Mobile Upload は Vantage Mobile Upload Backend にリクエストを送信します。

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

キー	説明
BaseURL	Vantage serverのメインドメインです。
TransactionID	トランザクションの識別子です。
Token	Vantage API への認証済みアクセスに使用される、エンコードされたアクセストークンです。
v	Vantage API のバージョンです。
md	1 つのトランザクションで取り込まれる文書数です。
redirect_uri	Vantage Mobile Upload の完了後に開くリダイレクト先のリンクです。
dt	文書タイプです。
ma	オンプレミス環境でマイクロアプリケーションを開始するために使用される、ABBYY Vantage クラウド環境のアドレスです。

リクエスト:

curl -X POST "https://mobilesessionmanager-eu.abbyy.com/api/v1/mobilesessions/retrive"
-H "accept: text/plain" \
-H "Content-Type: application/json" \
-F "Body=
    {
      "userCode": "String"
    }

レスポンス:

{
   "sessionData": "<Input Session Parameters>"
}

input session パラメーターの例:

{
\"sessionData\": \"https://mobilesessionmanager-eu.abbyy.com/mobile?baseUrl=<https://vantage-us.abbyy.com>&transactionId=<transaction-id>&token=<token>&v=<release_version>\"
}

{
\"sessionData\": \"https://mobilesessionmanager-eu.abbyy.com/mobile?baseUrl=<https://vantage-eu.abbyy.com>&transactionId=<transaction-id>&token=<token>&v=<release_version>\"
}

{
\"sessionData\": \"https://mobilesessionmanager-eu.abbyy.com/mobile?baseUrl=<https://vantage-au.abbyy.com>&transactionId=<transaction-id>&token=<token>&v=<release_version>\"
}

トランザクションのステータスの取得

Vantage Mobile Upload は、トランザクションの識別子とステータスを取得するためのリクエストを送信します。documentsをアップロードできるのは、ステータスが New のトランザクションのみです。 主なパラメーター

キー	説明
TransactionID	トランザクションの識別子です。
Status	トランザクションのステータスです。使用できる値: New, Processing, Processed, Failed, Canceled

リクエスト:

GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id

GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id

GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id

レスポンス:

{
   "id": "<TransactionID>",
   "status": "<Status>"
}

文書画像の分析用モデルのダウンロード

Vantage Mobile Upload は、iOS マイクロアプリケーション用に、文書画像内のページの端を検出するためのモデルをダウンロードするリクエストを送信します。 主なパラメーター

キー	説明
AbbyyRtrSDK-version	関連するパターンファイルのリクエストに使用する AbbyyRtrSDK フレームワークのバージョンです。値は Vantage のバージョンに応じて変わる場合があります。
PatternFileName	文書画像内のページの端を検出するために使用される AbbyyRtrSDK のファイルパターン名です。ファイルパターンには 6 種類あります: `FactCrop.imodel`, `CnnCrop.Classifier.cnnmodel`, `DIQClassifier.imodel`, `CnnCrop.Detector.GenericWithID.cnnmodel`, `DIQBlockClassifier.imodel`, `CropClassifierPhoto.imodel`

リクエスト:

GET https://vantage-us.abbyy.com/app_clip/mobile_sdk_assets/AbbyyRtrSDK-version/patterns/PatternFileName

GET https://vantage-eu.abbyy.com/app_clip/mobile_sdk_assets/AbbyyRtrSDK-version/patterns/PatternFileName

GET https://vantage-au.abbyy.com/app_clip/mobile_sdk_assets/AbbyyRtrSDK-version/patterns/PatternFileName

レスポンス:

File pattern

トランザクション内のdocuments一覧の取得

Vantage Mobile Upload は、documentsをトランザクションにアップロードする前に、トランザクション内に以前作成されたdocumentsがあるかどうかを確認するリクエストを送信します。トランザクションが空でない場合、Vantage Mobile Upload は新しいアップロードセッションを開始する前に、既存のすべてのdocumentsを削除するための Delete document リクエストを送信します。 主なパラメーター

キー	説明
TransactionID	トランザクションの識別子です。
DocumentID	Creating a document リクエストで取得したドキュメントの識別子です。
SourceFileID	文書画像の識別子です。
SourceFileName	文書画像の名前です。Vantage Mobile Upload は各画像のファイル名を自動生成し、Uploading Images to the document リクエストを使用してその画像をドキュメントにアップロードします。

リクエスト:

GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents

GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents

GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents

レスポンス:

[
   {
      "documentId": "<DocumentID>",
      "sourceFiles": 
      [
         {
           "id": "<SourceFileID>",
           "name": "<SourceFileName>.JPG"
         }
      ]
   }, 
   {
      "documentId": "<DocumentID>",
      "sourceFiles": 
      [
         {
           "id": "<SourceFileID>",
           "name": "<SourceFileName>.JPG"
         }
      ]
   }
]

トランザクション内の既存documentsの削除

処理を開始する前にトランザクションからdocumentsを削除するには、DELETE /api/publicapi/v1/transactions/{transactionId}/documents/{documentId} を使用します。これにより、ユーザーは次のことが可能になります:

誤って取り込まれたdocumentsを削除する
再取り込み前にdocumentsを消去する
トランザクション内のdocumentsセットを管理する

documentsは、トランザクションの処理開始前にのみ削除できます。

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

画像をアップロードする際、Vantage Mobile Upload は、トランザクション内の各ドキュメントに対してドキュメントインスタンスを作成するリクエストを送信します。 主なパラメーター

Key	Description
Token	Vantage API への認証済みアクセスに使用する、エンコードされたアクセストークン。
TransactionID	トランザクションの識別子。
DocumentID	ドキュメントの識別子。

リクエスト:

curl -X POST "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json; charset=utf-8" \
-F "Model=
    {
      "index": <Unsigned Integer Value: UI 内のドキュメントのインデックス>,
      "imageProcessingOptions": 
        {
           "autoOrientationCorrection": "<Yes/No/Default>",
           "autoCrop": "<Yes/No/Default>"
        }
    }

curl -X POST "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json; charset=utf-8" \
-F "Model=
    {
      "index": <Unsigned Integer Value: UI 内のドキュメントのインデックス>,
      "imageProcessingOptions": 
        {
           "autoOrientationCorrection": "<Yes/No/Default>",
           "autoCrop": "<Yes/No/Default>"
        }
    }

curl -X POST "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json; charset=utf-8" \
-F "Model=
    {
      "index": <Unsigned Integer Value: UI 内のドキュメントのインデックス>,
      "imageProcessingOptions": 
        {
           "autoOrientationCorrection": "<Yes/No/Default>",
           "autoCrop": "<Yes/No/Default>"
        }
    }

レスポンス:

{
   "documentId": "<DocumentID>"
}

撮影した画像を文書にアップロードする

ドキュメントインスタンスが作成されると、Vantage Mobile Upload はすべての画像を文書にアップロードするリクエストを送信します。1 つの文書に含まれるすべての画像は、1 回のリクエストでアップロードされます。 主なパラメーター

キー	説明
Token	Vantage API への認証済みアクセスに使用する、エンコードされたアクセストークン。
TransactionID	トランザクションの識別子。
DocumentID	Creating a document リクエストで受け取った文書の識別子。
SourceFileID	文書画像の識別子。
SourceFileName	文書画像の名前。Vantage Mobile Upload は各画像のファイル名を自動生成し、画像を文書にアップロードします。
ImageData	画像ファイルのエンコードされたデータ。documentsに画像をアップロードするために使用されます。

リクエスト:

curl -X POST "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data; boundary=<Boundary>" \
-F "Body=
    {
      "files": [
       {
         "index": 0,
         "registrationParameters": [
           {
            "key": "SourceType",
            "value": "Vantage Mobile Capture"
           }
         ]
        }
       ]
    },
    {
      "index": 1,
      ...
    },
      ...
   ]
 }

<Boundary>
Content-Disposition: form-data; name="Files"; filename="<SourceFileName>.JPG"
Content-Type: image/jpeg
<ImageData>

...
<Boundary>
Content-Disposition: form-data; name="Files"; filename="<SourceFileName>.JPG"
Content-Type: image/jpeg
<ImageData>
...
<Boundary>

curl -X POST "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data; boundary=<Boundary>" \
-F "Body=
    {
      "files": [
       {
         "index": 0,
         "registrationParameters": [
           {
            "key": "SourceType",
            "value": "Vantage Mobile Capture"
           }
         ]
        }
       ]
    },
    {
      "index": 1,
      ...
    },
      ...
   ]
 }

<Boundary>
Content-Disposition: form-data; name="Files"; filename="<SourceFileName>.JPG"
Content-Type: image/jpeg
<ImageData>

...
<Boundary>
Content-Disposition: form-data; name="Files"; filename="<SourceFileName>.JPG"
Content-Type: image/jpeg
<ImageData>
...
<Boundary>

curl -X POST "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data; boundary=<Boundary>" \
-F "Body=
    {
      "files": [
       {
         "index": 0,
         "registrationParameters": [
           {
            "key": "SourceType",
            "value": "Vantage Mobile Capture"
           }
         ]
        }
       ]
    },
    {
      "index": 1,
      ...
    },
      ...
   ]
 }

<Boundary>
Content-Disposition: form-data; name="Files"; filename="<SourceFileName>.JPG"
Content-Type: image/jpeg
<ImageData>

...
<Boundary>
Content-Disposition: form-data; name="Files"; filename="<SourceFileName>.JPG"
Content-Type: image/jpeg
<ImageData>
...
<Boundary>

レスポンス:

リクエストのステータスコード

トランザクションの開始

すべてのdocumentsが作成され、すべての画像がdocumentsにアップロードされると、Vantage Mobile Upload はトランザクションを開始するためのリクエストを送信します。 主なパラメーター

Key	説明
Token	Vantage API への認証済みアクセスに使用される、エンコードされたアクセストークン。
TransactionID	トランザクションの識別子。

リクエスト:

curl -X POST "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/start"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json; charset=utf-8" \

curl -X POST "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/start"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json; charset=utf-8" \

curl -X POST "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/start"
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json; charset=utf-8" \

レスポンス:

リクエストのステータスコード

概要

開発者ガイド

Vantage Mobile Input によって処理されるデータ

プラットフォーム別の API 呼び出し

iOS プラットフォーム

Android プラットフォーム

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

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

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

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

トランザクションのステータスの取得

文書画像の分析用モデルのダウンロード

トランザクション内のdocuments一覧の取得

トランザクション内の既存documentsの削除

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

撮影した画像を文書にアップロードする

トランザクションの開始

​プラットフォーム別の API 呼び出し

​iOS プラットフォーム

​Android プラットフォーム

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

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

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

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

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

​文書画像の分析用モデルのダウンロード

​トランザクション内のdocuments一覧の取得

​トランザクション内の既存documentsの削除

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

​撮影した画像を文書にアップロードする

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

プラットフォーム別の API 呼び出し

iOS プラットフォーム

Android プラットフォーム

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

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

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

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

トランザクションのステータスの取得

文書画像の分析用モデルのダウンロード

トランザクション内のdocuments一覧の取得

トランザクション内の既存documentsの削除

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

撮影した画像を文書にアップロードする

トランザクションの開始