Zum Hauptinhalt springen

Ein Konto erstellen

Um mit der API zu interagieren, benötigen Sie ein Konto. Falls Sie noch kein Konto erstellt haben, können Sie dies über das ABBYY FlexiCapture Cloud-Webportal tun.

Den Autorisierungsheader abrufen

Alle Anfragen an die API müssen einen Autorisierungsheader enthalten. So rufen Sie den Autorisierungsheader ab:
  1. Verketten Sie die Anwendungs-ID und das Token, wobei ein Doppelpunkt als Trennzeichen verwendet wird (die Anwendungs-ID und das Token finden Sie auf der Seite Applications im ABBYY FlexiCapture Cloud-Webportal).
  2. Kodieren Sie die resultierende Zeichenfolge mit einer beliebigen Base64-Variante.
  3. Stellen Sie der Zeichenfolge aus Schritt 2 die Autorisierungsmethode mit einem nachfolgenden Leerzeichen voran.
Anwendungs-ID = Aladdin, Token = OpenSesame
  1. Verketten Sie die Anwendungs-ID und das Token:
Aladdin:OpenSesame
  1. Kodieren Sie die Zeichenfolge mit einer beliebigen Base64-Variante:
QWxhZGRpbjpPcGVuU2VzYW1l
  1. Stellen Sie der Zeichenfolge aus Schritt 2 die Autorisierungsmethode mit einem nachfolgenden Leerzeichen voran:
Basic QWxhZGRpbjpPcGVuU2VzYW1l
  1. Der resultierende Autorisierungsheader sieht dann wie folgt aus:
Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l

Eine Datei hochladen

Laden Sie eine Datei auf den Server hoch. In der Antwort erhalten Sie den Bezeichner und das Token der Datei. Der Bezeichner und das Token werden in allen nachfolgenden Anfragen verwendet, die diese Datei betreffen. curl -X POST —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l” “https://api-{location-id}.flexicapture.com/v2/file” —form “file=@/path/to/file/Letter.tif” Unterstützte location-ids: us: USA und Kanada, au: Australien, eu: die Länder der Europäischen Union.
Die Projekteinstellungen für die Dokumentzusammenstellung werden beim Hochladen einer Datei über die REST API ignoriert. Für jede Datei wird ein separates Dokument erstellt.

Eine Aufgabe starten

Nachdem Ihr Dokument hochgeladen wurde, starten Sie eine Aufgabe, um die Datenextraktion zu starten. Sie können in dieser Anfrage mehrere Dateien angeben. Die Anfrage kann die folgenden optionalen Parameter enthalten: Rechnungs-Region, Verifizierungstyp und das Exportformat für die Ergebnisse. Die Antwort enthält einen Aufgabenbezeichner. curl -X POST —header “Content-Type: application/json” —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l” -d ”{ “properties”: { “region”: “US”, “export_format”: “Xls”, “verification_type”: “NoVerification”, }, “files”: [ { “id”: “5ea16ff21b777315586713bf”, “token”: “34FB84AA68684F0F2BF496045224EB6C436F596B” } ] }” “https://api-{location-id}.flexicapture.com/v2/task/capture/invoices Unterstützte location-ids: us: USA und Kanada, au: Australien, eu: die Länder der Europäischen Union.

Aufgaben-Status abrufen

Die Verarbeitung der Aufgabe kann einige Zeit in Anspruch nehmen, daher stehen die extrahierten Daten nicht sofort zur Verfügung. Sie können den Aufgaben-Status prüfen, indem Sie den Bezeichner verwenden, den Sie beim Starten der Aufgabe erhalten haben. Warten Sie, bis sich der status zu Done ändert. curl -X GET —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l” “https://api-{location-id}.flexicapture.com/v2/task/5ea18adc220e0d1c58177c59 Unterstützte location-ids: us: USA und Kanada, au: Australien, eu: die Länder der Europäischen Union.

Ergebnis herunterladen

Nachdem der Status der Aufgabe zu Done gewechselt hat, können Sie die Ausgabedateien anhand ihrer Bezeichner und Tokens herunterladen. Diese Anfrage kann für jede Eingabedatei in der Aufgabenanfrage wiederholt werden. curl -X GET —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l=” “https://api-{location-id}.flexicapture.com/v2/file/5ea21f6b7a9ae6193831d671/D188E5EFC0042A83529899AC1E1D94400A25DCF6 Unterstützte location-ids: us: USA und Kanada, au: Australien, eu: die Länder der Europäischen Union.

Aufgabe löschen

Löschen Sie nach dem Herunterladen der Ausgabedaten die Aufgabe, um alle Eingabe- und Ausgabedateien zu löschen. curl -X DELETE —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l=” “https://api-{location-id}.flexicapture.com/v2/task/5ea18adc220e0d1c58177c59 Unterstützte location-ids: us: USA und Kanada, au: Australien, eu: die Länder der Europäischen Union.