API-Referenz

Die ABBYY FlexiCapture for Invoices Cloud API ist als REST-API aufgebaut. Mit der API können Sie auf Ressourcen des ABBYY FlexiCapture Cloud Service zugreifen. Nachdem Sie sich registriert und den Header für die Authentifizierung erhalten haben, können Sie Anfragen an die ABBYY FlexiCapture for Invoices Cloud API senden. Die API verwendet integrierte HTTP-Funktionen wie HTTP-Authentifizierung und HTTP-Verben, die von gängigen HTTP-Clients unterstützt werden. Das ABBYY FlexiCapture Cloud-Webportal enthält das API-Schema im Swagger-Format. Sie können es verwenden, um mithilfe spezieller Tools, z. B. des Swagger Editor, Client-Code in der Sprache zu generieren, die Sie für Ihr Projekt verwenden.

API-Endpoint

https://api-{location-id}.flexicapture.com

Ersetzen Sie {location-id} durch eine der unterstützten Regionen:

us: USA und Kanada
au: Australien
eu: die Länder der Europäischen Union

REST-Ressourcen

Die folgenden Endpoint-Pfade sind relativ zum oben beschriebenen API-Endpoint.

v2.file

Methode	Endpoint	Beschreibung
Hochladen	`POST /v2/file`	Laden Sie eine oder mehrere Dateien in die Cloud hoch.
Herunterladen	`GET /v2/file/{id}/{token}`	Laden Sie eine Datei aus der Cloud herunter.
Abrufen	`GET /v2/file/{id}/{token}/info`	Gibt Dateimetadaten zurück.
Löschen	`DELETE /v2/file/{id}/{token}`	Löschen Sie eine Datei aus der Cloud.

v2.task

Methode	Endpoint	Beschreibung
Ausführen	`POST /v2/task/capture/invoices`	Führen Sie eine Rechnungserfassungsaufgabe aus.
Abrufen	`GET /v2/task/{id}`	Rufen Sie Aufgabeninformationen anhand der Task ID ab.
Delete	`DELETE /v2/task/{id}`	Löschen Sie Aufgabendaten anhand der Task ID.

v2.dataset

Methode	Endpoint	Beschreibung
Geschäftsbereich erstellen	`POST /v2/dataset/businessunits`	Erstellt eine Liste von Geschäftsbereichen.
Geschäftsbereich aktualisieren	`PUT /v2/dataset/businessunits`	Aktualisiert Informationen zu Geschäftsbereichen im Dataset.
Geschäftsbereich abrufen	`GET /v2/dataset/businessunits/{region}`	Gibt eine Liste von Geschäftsbereichen für die angegebene Region zurück.
Geschäftsbereich nach Region entfernen	`DELETE /v2/dataset/businessunits/{region}`	Entfernt Geschäftsbereiche aus der angegebenen Region aus dem Dataset.
Geschäftsbereich nach ID entfernen	`DELETE /v2/dataset/businessunit/{region}/{externalId}`	Entfernt einen Geschäftsbereich mit der angegebenen externen ID aus dem Dataset.
Vendor erstellen	`POST /v2/dataset/vendors`	Erstellt eine Liste von Vendors.
Vendor aktualisieren	`PUT /v2/dataset/vendors`	Aktualisiert Informationen zu Vendors im Dataset.
Vendor abrufen	`GET /v2/dataset/vendors/{region}`	Gibt eine Liste von Vendors für die angegebene Region zurück.
Vendor nach Region entfernen	`DELETE /v2/dataset/vendors/{region}`	Entfernt Vendors aus der angegebenen Region aus dem Dataset.
Vendor nach ID entfernen	`DELETE /v2/dataset/vendor/{region}/{externalId}/{businessUnitId}`	Entfernt einen Vendor mit der angegebenen externen ID aus dem Dataset.

v2.training

Methode	Endpoint	Beschreibung
Trainieren	`POST /v2/training`	Ein Erfassungsmodell trainieren.
Layout	`GET /v2/training/layout/{taskId}/{fileId}`	Layout der erfassten Daten abrufen.

Administrator's Guide

Administration Guide

Performance Guide

Troubleshooting

Cloud

API-Endpoint

REST-Ressourcen

v2.file

v2.task

v2.dataset

v2.training

​API-Endpoint

​REST-Ressourcen

​v2.file

​v2.task

​v2.dataset

​v2.training

API-Endpoint

REST-Ressourcen

v2.file

v2.task

v2.dataset

v2.training