Migration auf die 2. Version der API

Wenn Sie von Version 1 auf Version 2 der ABBYY FlexiCapture for Invoices Cloud REST API upgraden, müssen Sie einige Änderungen an Ihrem Code vornehmen. Zu den wichtigsten Änderungen gehören:

Anwendungen Die neue Version führt das Konzept von Anwendungen ein. Ein Konto kann mehrere Anwendungen haben, die unabhängig voneinander arbeiten. Jede Anwendung kann nur mit ihren eigenen Aufgaben, Verarbeitungsdaten und trainierten Modellen arbeiten und nicht auf Informationen anderer Anwendungen zugreifen.
Mehrspaltige Felder Die Felder können jetzt Varianten haben, sodass unterschiedliche Schreibweisen und Fehler berücksichtigt werden können. Das erleichtert die Zuordnung von Vendors und Geschäftsbereichen. Die erfassten Felder werden als Arrays mit Varianten dargestellt.
Version in URLs aktualisiert Die URLs wurden entsprechend der Version umbenannt: Das v1 in der URL wurde in v2 geändert.

Sie müssen einen Teil Ihres Codes anpassen, um diese Unterschiede zu berücksichtigen. Die API-Methoden der ersten Version sind unten aufgeführt. Öffnen Sie den Unterabschnitt für jede Methode, um zu sehen, wie sie sich in der zweiten Version geändert hat. Die Änderungen an den URLs sind fett hervorgehoben.

Arbeiten mit Dateien

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

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

den Abfrageparameter email entfernt; stattdessen wird die E-Mail-Adresse des Kontos verwendet
der Antwort hinzugefügt: application (Anwendungs-ID) und expiring (das Ablaufdatum der Datei)
aus der Antwort entfernt: die Schlüssel für die Dateivalidierung und -löschung (validated, is_validated, deleted, is_deleted), die Fehlermeldung (error) und die Seitenanzahl (pages_count)

GET https://api-{location-id}.flexicapture.com/v1/file/{id}/{token}/info

GET https://api-{location-id}.flexicapture.com/v2/file/{id}/{token}/info

für gelöschte Dateien können keine Metadaten mehr abgerufen werden; stattdessen wird jetzt der Statuscode 404 zurückgegeben
der Antwort hinzugefügt: application (Anwendungs-ID) und expiring (das Ablaufdatum der Datei)
aus der Antwort entfernt: die Schlüssel für die Dateivalidierung und -löschung (validated, is_validated, deleted, is_deleted), die Fehlermeldung (error) und die Seitenanzahl (pages_count)

GET https://api-{location-id}.flexicapture.com/v1/file/{id}/{token}

GET https://api-{location-id}.flexicapture.com/v2/file/{id}/{token}

DELETE https://api-{location-id}.flexicapture.com/v1/file/{id}/{token}

DELETE https://api-{location-id}.flexicapture.com/v2/file/{id}/{token}

Dokumente erfassen

POST https://api-{location-id}.flexicapture.com/v1/capture/data

POST https://api-{location-id}.flexicapture.com/v2/task/capture/documents

Die Änderungen an den Request-Parametern:

der Request-Body darf die Schlüssel email und label nicht mehr enthalten
die Schlüssel region, export_format und verification_type wurden in das Dictionary properties verschoben

Die Änderungen an der Antwort:

hinzugefügte Schlüssel: batch_id, is_realtime_enabled, processing_priority, is_demo, account, application, is_extra_error, documents > data, documents > is_moved, documents > traininglayout_fileid
entfernte Schlüssel: label, lead_time, started, delivered, deleted, wait_for_action, is_test, region, export_format, verification_type, business_unit, properties > export_format, properties > verification_type
das Array services wurde entfernt; der Schlüssel files wurde aus dem Array services in das Array documents verschoben
number ist jetzt string statt integer
progress ist jetzt eine Gleitkommazahl statt integer

Aufgaben zur Rechnungserfassung

POST https://api-{location-id}.flexicapture.com/v1/capture/invoices

POST https://api-{location-id}.flexicapture.com/v2/task/capture/invoices

Änderungen an den Request-Parametern:

der Request-Body darf die Schlüssel business_unit, email und label nicht mehr enthalten
die Schlüssel region, export_format und verification_type wurden in das Dictionary properties verschoben

Änderungen an der Antwort:

hinzugefügte Schlüssel: batch_id, is_realtime_enabled, processing_priority, is_demo, account, application, is_extra_error, documents > data, documents > is_moved, documents > traininglayout_fileid
entfernte Schlüssel: label, lead_time, started, delivered, deleted, wait_for_action, is_test, region, export_format, verification_type, business_unit, properties > export_format, properties > verification_type
das Array services wurde entfernt; der Schlüssel files wurde aus dem Array services in das Array documents verschoben
number ist jetzt string statt integer
progress ist jetzt eine Gleitkommazahl statt integer
die Schlüssel region, export_format und verification_type wurden in das Dictionary properties verschoben

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

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

Die Antwort ist jetzt genauso strukturiert wie bei der Methode zum Erstellen von Aufgaben.

hinzugefügte Schlüssel, ähnlich wie bei der Methode zum Erstellen von Aufgaben: batch_id, is_realtime_enabled, processing_priority, is_demo, account, application, documents_count, pages_count, is_extra_error, documents > data, documents > is_moved, documents > traininglayout_fileid
weitere hinzugefügte Schlüssel: für die extrahierten Daten documents > data > {region, export_format, verification_type, vendor_name, invoice_date, total, currency}, für die Aufgabenabrechnung: billed, is_billed
entfernte Schlüssel: label, lead_time, deleted, wait_for_action, is_test, region, export_format, verification_type, business_unit,
das Array services wurde entfernt; der Schlüssel files wurde aus dem Array services in das Array documents verschoben
number ist jetzt string statt integer
progress ist jetzt eine Gleitkommazahl statt integer
die Schlüssel region, export_format und verification_type wurden in das Dictionary properties verschoben

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

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

Arbeiten mit Datensätzen

POST https://api-{location-id}.flexicapture.com/v1/dataset/businessunits

POST https://api-{location-id}.flexicapture.com/v2/dataset/businessunits

Sowohl in der Anfrage als auch in der Antwort enthalten die folgenden Schlüssel nun Arrays mit Varianten: name, street, city, state, zip, vat

PUT https://api-{location-id}.flexicapture.com/v1/dataset/businessunits

PUT https://api-{location-id}.flexicapture.com/v2/dataset/businessunits

Sowohl in der Anfrage als auch in der Antwort enthalten die folgenden Schlüssel nun Arrays mit Varianten: name, street, city, state, zip, vat

GET https://api-{location-id}.flexicapture.com/v1/dataset/businessunits/{region}

GET https://api-{location-id}.flexicapture.com/v2/dataset/businessunits/{region}

Optionale Abfrageparameter können jetzt verwendet werden, um die Daten eines Geschäftsbereichs abzurufen: externalId, skip, takeSowohl in der Anfrage als auch in der Antwort enthalten die folgenden Schlüssel nun Arrays mit Varianten: name, street, city, state, zip, vat

DELETE https://api-{location-id}.flexicapture.com/v1/dataset/businessunits/{region}

DELETE https://api-{location-id}.flexicapture.com/v2/dataset/businessunits/{region}

DELETE https://api-{location-id}.flexicapture.com/v1/dataset/businessunit/{region}/{externalId}

DELETE https://api-{location-id}.flexicapture.com/v2/dataset/businessunit/{region}/{externalId}

POST https://api-{location-id}.flexicapture.com/v1/dataset/vendors

POST https://api-{location-id}.flexicapture.com/v2/dataset/vendors

Sowohl in der Anfrage als auch in der Antwort enthalten die folgenden Schlüssel nun Arrays mit Varianten: name, street, city, state, zip, vat, national_vat, iban, bank_account, bank_code, gl_code

PUT https://api-{location-id}.flexicapture.com/v1/dataset/vendors

PUT https://api-{location-id}.flexicapture.com/v2/dataset/vendors

GET https://api-{location-id}.flexicapture.com/v1/dataset/vendors/{region}

GET https://api-{location-id}.flexicapture.com/v2/dataset/vendors/{region}

DELETE https://api-{location-id}.flexicapture.com/v1/dataset/vendors/{region}

DELETE https://api-{location-id}.flexicapture.com/v2/dataset/vendors/{region}

DELETE https://api-{location-id}.flexicapture.com/v1/dataset/vendors/{region}/{externalId}

DELETE https://api-{location-id}.flexicapture.com/v2/dataset/vendors/{region}/{externalId}

Trainieren der Modelle für die Datenerfassung

POST https://api-{location-id}.flexicapture.com/v1/data/train

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

PUT https://api-{location-id}.flexicapture.com/v1/data/train

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

GET https://api-{location-id}.flexicapture.com/v1/data/{taskId}/{fileId}

GET https://api-{location-id}.flexicapture.com/v2/training/layout/{taskId}/{fileId}

POST https://api-{location-id}.flexicapture.com/v1/data/train/station/{taskId}

POST https://api-{location-id}.flexicapture.com/v2/training/station/{taskId}

PUT https://api-{location-id}.flexicapture.com/v1/data/train/station/{taskId}

PUT https://api-{location-id}.flexicapture.com/v2/training/station/{taskId}

GET https://api-{location-id}.flexicapture.com/v1/data/batch/{region}

GET https://api-{location-id}.flexicapture.com/v2/training/batch{region}

​Arbeiten mit Dateien

​Dokumente erfassen

​Aufgaben zur Rechnungserfassung

​Arbeiten mit Datensätzen

​Trainieren der Modelle für die Datenerfassung

Arbeiten mit Dateien

Dokumente erfassen

Aufgaben zur Rechnungserfassung

Arbeiten mit Datensätzen

Trainieren der Modelle für die Datenerfassung