Zum Hauptinhalt springen
Ein typisches Szenario für die Verarbeitung von Dokumenten mit einem einzelnen API-Aufruf (zum Erstellen eines Vorgangs, Hochladen einer Datei und Starten eines Vorgangs) umfasst die folgenden Schritte:
  1. Abrufen einer Liste aller verfügbaren Skills
  2. Erstellen und Starten eines Vorgangs
  3. Überwachen des Vorgangsstatus
  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 nur eine einzelne Datei mit weniger als 30 MB haben und die Bilder der Datei nicht bearbeiten müssen.

​
Liste aller verfügbaren Skills abrufen

Senden Sie dazu eine GET-Anfrage an die Ressource skills: 
GET https://your-server/api/publicapi/v1/skills
Führen Sie den folgenden Befehl aus: Unter Windows: 
curl -X GET "https://your-server/api/publicapi/v1/skills" \
-H "Authorization: Bearer token"
Unter Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/skills' \
-H 'Authorization: Bearer token'
Als Ergebnis erhalten Sie Informationen zu allen der Anwendungsinstanz hinzugefügten Skills.

​
Erstellen und Starten eines Vorgangs

Senden Sie dazu eine POST-Anfrage an die Ressource transactions/launch: 
POST https://your-server/api/publicapi/v1/transactions/launch
Geben Sie im Anfragetext den Parameter skillId an, der vom vorherigen API-Aufruf zurückgegeben wurde, und senden Sie die zu verarbeitende Datei. Ein Beispiel für einen Anfragetext kann wie folgt aussehen: 
{
  "settings": {
    "skillId": "00000000-0000-0000-0000-000000000001"
  },
  "files": [
    {
      "file": "Bildinhalt"
    }
  ]
}
Führen Sie den folgenden Befehl aus: Für Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/launch" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"settings\": {
     \"skillId\": \"00000000-0000-0000-0000-000000000001\"
   },
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
Unter Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/launch' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "settings": {
     "skillId": "00000000-0000-0000-0000-000000000001"
   },
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'
Als Ergebnis erhalten Sie eine Antwort, die die ID des erstellten Vorgangs enthält.

​
Den Status des Vorgangs überwachen

Senden Sie dazu eine GET-Anfrage an die Ressource transactions: 
GET https://ihr-server/api/publicapi/v1/transactions/transaction-id
Führen Sie den folgenden Befehl aus: Für Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"
Unter Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'
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.

​
Herunterladen von Quelldateien und Ergebnisdateien

Um die Quelldatei 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: 
GET https://Ihr-Server/api/publicapi/v1/transactions/transaction-id/files/file-id/download
Führen Sie den folgenden Befehl aus: Für Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"
Unter Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'