Zum Hauptinhalt springen
Vantage Mobile Upload kommuniziert über API-Aufrufe mit dem Vantage-Server. Diese Aufrufe dienen dazu, Dokumente zu erstellen, Bilder hochzuladen und die Verarbeitung von Vorgängen mit bestimmten Parametern zu starten.

​
iOS-Plattform

Die iOS-Micro-App von Vantage Mobile Input nutzt die folgenden API-Aufrufe:
  1. Übermitteln der Parameter der Eingabesitzung an das Vantage Mobile Upload Backend
  2. Abrufen der Parameter der Eingabesitzung vom Vantage Mobile Upload Backend
  3. Abfragen des Status der Transaction
  4. Herunterladen von Modellen zur Analyse von Dokumentbildern
  5. Abrufen der Liste der Dokumente in der Transaction
  6. Löschen vorhandener Dokumente in der Transaction
  7. Erstellen eines Dokuments in der Transaction
  8. Hochladen erfasster Bilder zum Dokument
  9. Starten der Transaction

​
Android-Plattform

Die Android-Micro-App von Vantage Mobile Input verwendet die folgenden API-Aufrufe:
  1. Abfragen des Status des Vorgangs
  2. Herunterladen von Modellen zur Analyse von Dokumentbildern
  3. Abrufen der Liste der Dokumente im Vorgang
  4. Löschen vorhandener Dokumente im Vorgang
  5. Erstellen eines Dokuments im Vorgang
  6. Hochladen aufgenommener Bilder zum Dokument
  7. Starten des Vorgangs

​
Eingabesitzungsparameter an das Vantage Mobile Upload Backend übermitteln

Um zu protokollieren, wann der Benutzer mit der Erfassung von Dokumenten beginnt und von welchem Gerät, verwenden Sie POST /api/mobileinputbackend/v1/inputsessions. Diese Ressource akzeptiert die folgenden Parameter:

​
Eingabesitzungsparameter

ParameterTypeBeschreibung
transactionIdstring (uuid)Erforderlich. Vorgangskennung, die im mobilen Upload-Link angegeben ist.
platformstringErforderlich. Die mobile Plattform des Geräts, auf dem die Mikroanwendung geöffnet ist. Mögliche Werte: iOS, Android, Web.
deviceModelstringOptional. Das Modell des Geräts, auf dem die Mikroanwendung geöffnet ist.
OSVersionstringOptional. Die Betriebssystemversion des Geräts, auf dem die Mikroanwendung geöffnet ist.
MIVersionstringOptional. Die vom Gerät geöffnete Version von Vantage Mobile Input.

​
Eingabesitzungsparameter aus dem Vantage Mobile Upload Backend abrufen

Um zu überprüfen, wann der Benutzer mit der Erfassung von Dokumenten begonnen hat, verwenden Sie GET /api/mobileinputbackend/v1/inputsessions/{transactionId}. Diese Ressource gibt die folgenden Parameter zurück:

​
Eingabesitzungsparameter

ParameterTypeBeschreibung
transactionIdstring (uuid)Kennung der Transaction, die im mobilen Upload-Link angegeben ist.
platformstringDie mobile Plattform des Geräts, auf dem die Micro-Anwendung geöffnet wird. Mögliche Werte: iOS, Android, Web.
deviceModelstringDas Gerätemodell, auf dem die Micro-Anwendung geöffnet wird.
OSVersionstringDie Betriebssystemversion des Geräts, auf dem die Micro-Anwendung geöffnet wird.
MIVersionstringDie vom Gerät geöffnete Version von Vantage Mobile Input.
createdAtstring (date-time)Datum und Uhrzeit der Erstellung der Eingabesitzung.

​
Abrufen des Status des Vorgangs

Um den aktuellen Status des Vorgangs beim Erfassen und Hochladen von Dokumenten zu überprüfen, verwenden Sie GET /api/publicapi/v1/transactions/{transactionId}. Diese Ressource liefert Informationen zum Vorgang, darunter:
  • transactionId. Der eindeutige Bezeichner des Vorgangs
  • status. Aktueller Status des Vorgangs (New, Queued, InProgress, Processed, etc.)
  • createdAt. Zeitpunkt der Erstellung des Vorgangs
  • documents. Array der Dokumente im Vorgang

​
Herunterladen der Modelle zur Analyse von Dokumentbildern

Um Machine-Learning-Modelle herunterzuladen, die Dokumentbilder hinsichtlich Qualität und Typ erkennen, verwenden Sie GET /api/mobileinputbackend/v1/models. Dieser Endpunkt stellt Modelle bereit, die der mobilen App helfen:
  • Dokumentgrenzen zu erkennen
  • Die Bildqualität zu prüfen
  • Dokumenttypen zu identifizieren
  • Aufgenommene Bilder zu validieren

​
Abrufen der Dokumente im Vorgang

Um alle aktuell dem Vorgang zugeordneten Dokumente abzurufen, verwenden Sie GET /api/publicapi/v1/transactions/{transactionId}/documents. Diese Ressource gibt ein Array von Dokumentobjekten zurück. Jedes Objekt enthält:
  • id. Dokumentkennung
  • name. Dokumentname
  • status. Verarbeitungsstatus des Dokuments
  • files. Array von Dateien (Bildern), die dem Dokument zugeordnet sind

​
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
Hinweis: Dokumente können nur gelöscht werden, bevor der Vorgang verarbeitet wird.

​
Erstellen eines Dokuments im Vorgang

Um ein neues Dokument im Vorgang zum Hochladen von Bildern zu erstellen, verwenden Sie POST /api/publicapi/v1/transactions/{transactionId}/documents. Beispiel für den Anforderungstext: 
{
  "documents": [
    {
      "name": "Rechnung",
      "index": 0
    }
  ]
}
Dies gibt eine Document-ID zurück, die zum Hochladen von Bildern verwendet wird.

​
Aufgezeichnete Bilder in das Dokument hochladen

Um aufgezeichnete Bilder in ein bestimmtes Dokument hochzuladen, verwenden Sie POST /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}/sourceFiles. Die Anforderung muss Folgendes enthalten:
  • Formulardaten mit den Bilddateien
  • Optionale Metadaten zu jeder Datei
  • Optionen zur Bildverarbeitung (autoCrop, autoOrientation)
Anforderungsformat: 
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"

​
Starten des Vorgangs

Um die Verarbeitung aller hochgeladenen Dokumente im Vorgang zu starten, verwenden Sie POST /api/publicapi/v1/transactions/{transactionId}/start. Dadurch wird der Verarbeitungs-Workflow mit dem Skill gestartet, der bei der Erstellung des Vorgangs angegeben wurde. Beispiel für eine Anforderung: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/start" \
-H "Authorization: Bearer token"
Nach dem Start:
  • Der Vorgangsstatus wechselt auf Queued oder InProgress
  • Dokumente werden gemäß dem konfigurierten Skill verarbeitet
  • Ergebnisse sind verfügbar, sobald der Status Processed erreicht ist
  • Sie können den Fortschritt über den Endpunkt für den Vorgangsstatus verfolgen