Rechnungen über die API verarbeiten

Diese Anleitung zeigt, wie Sie Ihre ersten Rechnungen mit der ABBYY FlexiCapture for Invoices Cloud API verarbeiten: Erstellen Sie den Autorisierungsheader, laden Sie eine Datei hoch, starten Sie eine Aufgabe und laden Sie die Ergebnisse herunter. Alle Endpunkte verwenden die Basis-URL https://api-{location-id}.flexicapture.com, wobei {location-id} die unterstützte Region ist: us (USA und Kanada), au (Australien) oder eu (Länder der Europäischen Union).

Konto erstellen

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

Authorization-Header abrufen

Alle Anfragen an die API müssen einen Authorization-Header enthalten, der aus Ihrer Application ID und Ihrem Token erstellt wird. Anleitungen dazu finden Sie unter Authentifizierung. In den folgenden Beispielen wird der Beispiel-Header Basic QWxhZGRpbjpPcGVuU2VzYW1l verwendet.

Datei hochladen

Laden Sie eine Datei auf den Server hoch. Sie erhalten in der Antwort den Bezeichner und das Token der Datei; sie werden in allen nachfolgenden Anfragen zu dieser Datei verwendet.

curl -X POST \
  --header "Accept: application/json" \
  --header "Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l" \
  --form "file=@/path/to/file/Letter.tif" \
  "https://api-{location-id}.flexicapture.com/v2/file"

Die Projekteinstellungen für die Dokumentzusammenstellung werden beim Hochladen einer Datei über die REST API nicht berücksichtigt. Für jede Datei wird ein separates Dokument erstellt.

Aufgabe starten

Nachdem Ihr Dokument hochgeladen wurde, starten Sie einen Task, um die Datenextraktion zu beginnen. Sie können in dieser Anfrage mehrere Dateien angeben. Die Anfrage kann die folgenden optionalen Parameter enthalten: Rechnung Region, Verifizierungstyp und das Exportformat für die Ergebnisse. Die Antwort enthält einen Task-Bezeichner.

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"

Task-Status abrufen

Die Verarbeitung der Aufgabe nimmt einige Zeit in Anspruch, daher sind die extrahierten Daten nicht sofort verfügbar. Sie können den Aufgabenstatus überprüfen, indem Sie den Bezeichner verwenden, den Sie beim Starten der Aufgabe erhalten haben. Warten Sie, bis der Status Done lautet.

curl -X GET \
  --header "Accept: application/json" \
  --header "Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l" \
  "https://api-{location-id}.flexicapture.com/v2/task/5ea18adc220e0d1c58177c59"

Laden Sie das Ergebnis herunter

Nachdem sich der Task-Status in Done geändert hat, können Sie die Ausgabedateien mithilfe ihrer Bezeichner und Token herunterladen. Wiederholen Sie die Anfrage für jede Eingabedatei in der Task-Anfrage.

curl -X GET \
  --header "Accept: application/json" \
  --header "Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l" \
  "https://api-{location-id}.flexicapture.com/v2/file/5ea21f6b7a9ae6193831d671/D188E5EFC0042A83529899AC1E1D94400A25DCF6"

Aufgabe löschen

Nachdem Sie die Ausgabedaten heruntergeladen haben, löschen Sie die Aufgabe, um alle Ein- und Ausgabedateien zu entfernen.

curl -X DELETE \
  --header "Accept: application/json" \
  --header "Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l" \
  "https://api-{location-id}.flexicapture.com/v2/task/5ea18adc220e0d1c58177c59"

Administrator's Guide

Administration Guide

Performance Guide

Troubleshooting

Cloud

Rechnungen über die API verarbeiten