Zum Hauptinhalt springen
Ein typisches Szenario für die Verarbeitung von Dokumenten mit einem einzelnen API-Aufruf (um einen Vorgang zu erstellen, eine Datei hochzuladen und den Vorgang zu starten) besteht aus den folgenden Schritten:
  1. Abrufen einer Liste aller verfügbaren Skills.
  2. Erstellen und Starten eines Vorgangs.
  3. Überwachen des Status des Vorgangs.
  4. Herunterladen von Quelldateien und Ergebnisdateien.
Jede Anfrage an den Server muss Authentifizierungsinformationen enthalten. Weitere Informationen finden Sie unter Authentication. Verwenden Sie dieses Szenario, wenn Sie eine Datei mit weniger als 30 MB Größe haben und die Bilder dieser Datei nicht bearbeiten müssen.

​
Schritt 1. Liste aller verfügbaren Skills abrufen

Senden Sie eine GET-Anfrage an die Ressource skills, um eine Liste aller verfügbaren Skills zu erhalten: Führen Sie den folgenden Befehl aus: Als Ergebnis erhalten Sie Informationen zu allen Skills, die der Anwendungsinstanz hinzugefügt wurden.

​
Schritt 2: Vorgang erstellen und starten

Um einen Vorgang zu erstellen und zu starten, senden Sie eine POST-Anfrage an die Ressource transactions/launch: Geben Sie in der URL den skillId-Abfrageparameter an, der beim vorherigen API-Aufruf zurückgegeben wurde. Senden Sie im Body die zu verarbeitende Datei zusammen mit optionalen Metadaten. Sie können außerdem optionale registrationParameters und skillParameters im Request-Body übergeben. Nachfolgend ein Beispiel für einen Request-Body: 
{
  "files": [
    {
    }
  ]
}
Führen Sie den folgenden Befehl aus: Daraufhin erhalten Sie eine Antwort, die die ID des erstellten Vorgangs enthält.

​
Schritt 3. Den Status des Vorgangs überwachen

Senden Sie dazu eine GET-Anfrage an die Ressource transactions: Führen Sie den folgenden Befehl aus: Als Ergebnis erhalten Sie eine Antwort mit dem Status des Vorgangs. Die Verarbeitung des Vorgangs kann einen der folgenden Status aufweisen:
  • New. Der Vorgang wurde erstellt, aber noch nicht zur Verarbeitung in die Warteschlange gestellt.
  • Queued. Der Vorgang befindet sich zur Verarbeitung in der Warteschlange.
  • InProgress. Der Vorgang wird verarbeitet.
  • Processed. Der Vorgang wurde erfolgreich verarbeitet.
  • ProcessedWithWarnings. Der Vorgang wurde verarbeitet, es sind jedoch Warnungen aufgetreten.
  • NotProcessed. Der Vorgang wurde aufgrund eines Fehlers nicht verarbeitet.
  • Deleted. Der Vorgang wurde vom Benutzer oder automatisch gemäß der Aufbewahrungsrichtlinie gelöscht.
Wenn der Status des Vorgangs Processed oder ProcessedWithWarnings ist, fahren Sie mit Schritt 4 fort.

​
Schritt 4. Herunterladen von Quelldateien und Ergebnisdateien

Um Quelldateien und Ergebnisdateien herunterzuladen, senden Sie eine GET-Anfrage an die Ressource transactions/files/download und geben dabei die Datei-ID an, die Sie in der vorherigen Anfrage erhalten haben: Führen Sie den folgenden Befehl aus: