Von Vantage Mobile Input verarbeitete Daten

Vantage Mobile Upload kommuniziert mittels API-Aufrufen mit dem Vantage-Server. Diese Aufrufe werden verwendet, um Dokumente zu erstellen, Bilder hochzuladen und die Verarbeitung von Vorgängen mit bestimmten Parametern zu starten.

API-Aufrufe nach Plattformen

iOS-Plattform

Die iOS-Micro-App von Vantage Mobile Input nutzt die folgenden API-Aufrufe:

Übermitteln der Parameter der Eingabesitzung an das Vantage Mobile Upload Backend
Abrufen der Parameter der Eingabesitzung vom Vantage Mobile Upload Backend
Abfragen des Status der Transaction
Herunterladen von Modellen zur Analyse von Dokumentbildern
Abrufen der Liste der Dokumente in der Transaction
Löschen vorhandener Dokumente in der Transaction
Erstellen eines Dokuments in der Transaction
Hochladen erfasster Bilder zum Dokument
Starten der Transaction

Android-Plattform

Die Android-Micro-App von Vantage Mobile Input verwendet die folgenden API-Aufrufe:

Abfragen des Status des Vorgangs
Herunterladen von Modellen zur Analyse von Dokumentbildern
Abrufen der Liste der Dokumente im Vorgang
Löschen vorhandener Dokumente im Vorgang
Erstellen eines Dokuments im Vorgang
Hochladen aufgenommener Bilder zum Dokument
Starten des Vorgangs

Eingabesitzungsparameter an das Vantage Mobile Upload Backend übermitteln

Vantage Mobile Input sendet Eingabesitzungsparameter an das Vantage Mobile Upload Backend. Diese Parameter werden für die Upload-Sitzung in der Android-Micro-App oder im Webbrowser verwendet.

Eingabesitzungsparameter

Schlüssel	Beschreibung
BaseURL	Die Hauptdomain des Vantage-Servers.
TransactionID	Der Bezeichner des Vorgangs.
Token	Das codierte Autorisierungs-Zugriffstoken, das für den autorisierten Zugriff auf die Vantage-API verwendet wird.
v	Die Version der Vantage-API.
md	Die Anzahl der Dokumente, die in einem Vorgang erfasst werden.
redirect_uri	Der Weiterleitungslink, der geöffnet wird, wenn Vantage Mobile Upload abgeschlossen ist.
dt	Der Dokumenttyp.
ma	Die Adresse der ABBYY Vantage-Cloud-Umgebung, die zum Starten von Micro Applications für On-Premises-Installationen verwendet wird.

Anfrage:

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"
    }

Antwort:

Statuscode der Anfrage

Eingabesitzungsparameter aus dem Vantage Mobile Upload Backend abrufen

Zum Abrufen der Eingabesitzungsparameter sendet Vantage Mobile Upload Anfragen an das Vantage Mobile Upload Backend.

Eingabesitzungsparameter

Schlüssel	Beschreibung
BaseURL	Die Hauptdomäne des Vantage-Servers.
TransactionID	Der Bezeichner des Vorgangs.
Token	Das codierte Zugriffstoken für den autorisierten Zugriff auf die Vantage-API.
v	Die Version der Vantage-API.
md	Die Anzahl der Dokumente, die in einem Vorgang erfasst werden.
redirect_uri	Der Weiterleitungslink, der geöffnet wird, sobald Vantage Mobile Upload abgeschlossen ist.
dt	Der Dokumenttyp.
ma	Die Adresse der ABBYY Vantage-Cloud-Umgebung, die zum Starten von Micro Applications für On-Premises-Installationen verwendet wird.

Anfrage:

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"
    }

Antwort:

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

Beispiel für Eingabesitzungsparameter:

{
\"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>\"
}

Abrufen des Status des Vorgangs

Vantage Mobile Upload sendet eine Anfrage, um die Vorgangs-ID und den Status abzurufen. Nur Vorgänge mit dem Status New eignen sich zum Hochladen von Dokumenten. Wichtige Parameter

Schlüssel	Beschreibung
TransactionID	Die ID des Vorgangs.
Status	Der Status des Vorgangs. Mögliche Werte: New, Processing, Processed, Failed, Canceled

Anfrage:

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

Antwort:

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

Herunterladen der Modelle zur Analyse von Dokumentbildern

Vantage Mobile Upload sendet Anfragen zum Herunterladen von Modellen zur Erkennung von Seitenkanten in Dokumentbildern für die iOS-Micro-App. Wichtige Parameter

Schlüssel	Beschreibung
AbbyyRtrSDK-version	Die Version des AbbyyRtrSDK-Frameworks, die verwendet wird, um die entsprechenden Pattern-Dateien anzufordern. Der Wert kann sich je nach Version von Vantage ändern.
PatternFileName	Der Name des AbbyyRtrSDK-Dateimusters, das zur Erkennung von Seitenkanten in Dokumentbildern verwendet wird. Es gibt sechs Typen von Dateimustern: `FactCrop.imodel`, `CnnCrop.Classifier.cnnmodel`, `DIQClassifier.imodel`, `CnnCrop.Detector.GenericWithID.cnnmodel`, `DIQBlockClassifier.imodel`, `CropClassifierPhoto.imodel`

Anfrage:

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

Antwort:

File pattern

Abrufen einer Liste der Dokumente im Vorgang

Bevor Dokumente in den Vorgang hochgeladen werden, sendet Vantage Mobile Upload eine Anfrage, um zu prüfen, ob der Vorgang bereits erstellte Dokumente enthält. Wenn der Vorgang nicht leer ist, sendet Vantage Mobile Upload vor einer neuen Upload-Sitzung eine Anfrage Dokument löschen, um alle vorhandenen Dokumente zu entfernen. Wichtige Parameter

Schlüssel	Beschreibung
TransactionID	Der Bezeichner des Vorgangs.
DocumentID	Der Bezeichner des Dokuments, das von der Anfrage Dokument erstellen zurückgegeben wurde.
SourceFileID	Der Bezeichner des Dokumentbilds.
SourceFileName	Der Name des Dokumentbilds. Vantage Mobile Upload generiert automatisch Dateinamen für jedes Bild und lädt die Bilder mit der Anfrage Bilder in das Dokument hochladen in das Dokument hoch.

Anfrage:

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

Antwort:

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

Löschen vorhandener Dokumente im Vorgang

Um ein Dokument aus dem Vorgang zu entfernen, bevor die Verarbeitung beginnt, verwenden Sie DELETE /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}. Dies ermöglicht Benutzerinnen und Benutzern:

Falsch erfasste Dokumente zu entfernen
Dokumente vor dem erneuten Erfassen zu löschen
Dokumentensätze im Vorgang zu verwalten

Dokumente können nur gelöscht werden, bevor der Vorgang verarbeitet wird.

Erstellen eines Dokuments im Vorgang

Zum Hochladen von Bildern sendet Vantage Mobile Upload eine Anfrage, um für jedes Dokument im Vorgang eine Dokumentinstanz zu erstellen. Wichtige Parameter

Schlüssel	Beschreibung
Token	Das codierte Zugriffstoken für den autorisierten Zugriff auf die Vantage-API.
TransactionID	Der Bezeichner des Vorgangs.
DocumentID	Der Bezeichner des Dokuments.

Anfrage:

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: document index in 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: document index in 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: document index in UI>,
      "imageProcessingOptions": 
        {
           "autoOrientationCorrection": "<Yes/No/Default>",
           "autoCrop": "<Yes/No/Default>"
        }
    }

Antwort:

{
   "documentId": "<DocumentID>"
}

Hochladen erfasster Bilder in das Dokument

Sobald die Dokumentinstanz erstellt wurde, sendet Vantage Mobile Upload eine Anfrage, um alle Bilder in das Dokument hochzuladen. Alle Bilder eines Dokuments werden in einer einzigen Anfrage hochgeladen. Wichtige Parameter

Schlüssel	Description
Token	Das codierte Zugriffstoken für die Autorisierung des Zugriffs auf die Vantage-API.
TransactionID	Der Bezeichner des Vorgangs.
DocumentID	Der Bezeichner des Dokuments, der aus der Anfrage Erstellen eines Dokuments erhalten wurde.
SourceFileID	Der Bezeichner des Dokumentbilds.
SourceFileName	Der Name des Dokumentbilds. Vantage Mobile Upload generiert automatisch Dateinamen für jedes Bild und lädt die Bilder in das Dokument hoch.
ImageData	Die codierten Informationen aus den Bilddateien. Sie werden verwendet, um Bilder in Dokumente hochzuladen.

Anfrage:

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>

Antwort:

Statuscode der Anfrage

Starten des Vorgangs

Sobald alle Dokumente erstellt und alle Bilder in die Dokumente hochgeladen wurden, sendet Vantage Mobile Upload eine Anfrage, um den Vorgang zu starten. Wichtige Parameter

Schlüssel	Beschreibung
Token	Das codierte Zugriffstoken, das für den autorisierten Zugriff auf die Vantage-API verwendet wird.
TransactionID	Der Bezeichner des Vorgangs.

Anfrage:

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" \

Antwort:

Statuscode der Anfrage

Overview

Developer Guide

Von Vantage Mobile Input verarbeitete Daten

API-Aufrufe nach Plattformen

iOS-Plattform

Android-Plattform

Eingabesitzungsparameter an das Vantage Mobile Upload Backend übermitteln

Eingabesitzungsparameter

Eingabesitzungsparameter aus dem Vantage Mobile Upload Backend abrufen

Eingabesitzungsparameter

Abrufen des Status des Vorgangs

Herunterladen der Modelle zur Analyse von Dokumentbildern

Abrufen einer Liste der Dokumente im Vorgang

Löschen vorhandener Dokumente im Vorgang

Erstellen eines Dokuments im Vorgang

Hochladen erfasster Bilder in das Dokument

Starten des Vorgangs

​API-Aufrufe nach Plattformen

​iOS-Plattform

​Android-Plattform

​Eingabesitzungsparameter an das Vantage Mobile Upload Backend übermitteln

​Eingabesitzungsparameter

​Eingabesitzungsparameter aus dem Vantage Mobile Upload Backend abrufen

​Eingabesitzungsparameter

​Abrufen des Status des Vorgangs

​Herunterladen der Modelle zur Analyse von Dokumentbildern

​Abrufen einer Liste der Dokumente im Vorgang

​Löschen vorhandener Dokumente im Vorgang

​Erstellen eines Dokuments im Vorgang

​Hochladen erfasster Bilder in das Dokument

​Starten des Vorgangs

API-Aufrufe nach Plattformen

iOS-Plattform

Android-Plattform

Eingabesitzungsparameter an das Vantage Mobile Upload Backend übermitteln

Eingabesitzungsparameter

Eingabesitzungsparameter aus dem Vantage Mobile Upload Backend abrufen

Eingabesitzungsparameter

Abrufen des Status des Vorgangs

Herunterladen der Modelle zur Analyse von Dokumentbildern

Abrufen einer Liste der Dokumente im Vorgang

Löschen vorhandener Dokumente im Vorgang

Erstellen eines Dokuments im Vorgang

Hochladen erfasster Bilder in das Dokument

Starten des Vorgangs