Zum Hauptinhalt springen
Ingest stellt die API auf Port 8080 des Service fineparser-ingest bereit. Senden Sie Dokumente ab, fragen Sie die Jobs wiederholt ab, bis sie abgeschlossen sind, und laden Sie anschließend die Ergebnisse herunter. Die API verfügt über keine Authentifizierung. Schalten Sie daher eine Komponente vor, die Aufrufer authentifiziert, bevor Sie die API extern zugänglich machen. Siehe Bereitstellen der API.

POST /parse

Eine multipart/form-data-Anfrage. Als Antwort wird 202 Accepted mit einer Job-ID pro Datei zurückgegeben. Bei einer Anfrage mit mehreren Dateien wird zusätzlich eine batchId zurückgegeben. Dateien, die nicht angenommen werden konnten, werden unter errors aufgeführt.
POST /parse ist nicht idempotent. Wird die Anfrage nach Überschreitung des Zeitlimits erneut gesendet, können doppelte Jobs entstehen.

GET /jobs/

Der Status eines abgeschlossenen Jobs wird für die in orchestrator.jobRetentionSeconds festgelegte Dauer (standardmäßig 24 Stunden) aufbewahrt. Danach gibt dieser Endpunkt 404 zurück, die Ergebnisse lassen sich jedoch weiterhin herunterladen.

GET /batch/

Gibt status für die gesamte Anfrage sowie jobs zurück, wobei jeder Job jobId, file und status in derselben Struktur wie bei GET /jobs/{jobId} enthält. Ein Batch ist nur dann successful, wenn alle seine Jobs erfolgreich sind.

GET /jobs//

Lädt ein Ergebnis herunter. Jeder Eintrag in files liegt bereits im Format {jobId}/{name} vor. Hängen Sie ihn daher einfach an /jobs/ an. Beim Herunterladen wird nichts gelöscht.

Fehler

Fehler werden als JSON zurückgegeben: {"error":{"code":"...","message":"..."}}. Werten Sie zur Fallunterscheidung code aus.

Grenzwerte

CORS

Um die API aus einem Browser von einem anderen Ursprung aus aufzurufen, geben Sie die Ursprünge kommagetrennt in ingest.cors.allowedOrigins an. Standardmäßig sind keine Ursprünge zugelassen.