Passer au contenu principal
Lorsque vous passez de la version 1 à la version 2 d’ABBYY FlexiCapture for Invoices Cloud REST API, vous devez apporter quelques modifications à votre code. Les modifications essentielles sont :
  • Applications — La version 2 introduit le concept d’applications. Un compte peut avoir plusieurs applications qui fonctionnent indépendamment. Chaque application ne peut utiliser que ses propres tâches, données de traitement et modèles d’entraînement, et ne peut accéder à aucune de ces informations pour d’autres applications.
  • Champs multicolonnes — Les champs peuvent désormais avoir des variantes, ce qui permet de prendre en compte les différences d’orthographe et les erreurs, et facilite l’association des fournisseurs et des unités commerciales. Les champs capturés sont représentés sous forme de tableaux contenant des variantes.
  • Version mise à jour dans les URL — Les URL ont été renommées en fonction de la version : v1 dans l’URL est devenu v2.
Les méthodes API de la version 1 sont répertoriées ci-dessous par catégorie. Chaque entrée affiche l’URL de la version 2 ainsi que les modifications apportées à la requête et à la réponse correspondantes.

Utilisation des fichiers

POST /file

POST https://api-{location-id}.flexicapture.com/v1/file
POST https://api-{location-id}.flexicapture.com/v2/file
  • Suppression du paramètre de requête email ; l’adresse e-mail du compte est utilisée à la place.
  • Ajout à la réponse : application (ID d’application) et expiring (date d’expiration du fichier).
  • Suppression de la réponse : les clés liées à la validation et à la suppression du fichier (validated, is_validated, deleted, is_deleted), le message d’erreur (error) et le nombre de pages (pages_count).

GET /file///info

GET https://api-{location-id}.flexicapture.com/v1/file/{id}/{token}/info
GET https://api-{location-id}.flexicapture.com/v2/file/{id}/{token}/info
  • Pour les fichiers supprimés, vous ne pouvez plus obtenir les métadonnées ; une réponse 404 est désormais renvoyée.
  • Ajoutés à la réponse : application (ID d’application) et expiring (la date d’expiration du fichier).
  • Supprimés de la réponse : les clés relatives à la validation et à la suppression du fichier (validated, is_validated, deleted, is_deleted), le message d’erreur (error) et le nombre de pages (pages_count).

GET /file//

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

DELETE /file//

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

Capture de documents

POST /task/capture/documents

POST https://api-{location-id}.flexicapture.com/v1/capture/data
POST https://api-{location-id}.flexicapture.com/v2/task/capture/documents
Modifications apportées à la requête :
  • Le corps de la requête ne doit plus contenir les clés email et label.
  • Les clés region, export_format et verification_type ont été déplacées dans le dictionnaire properties.
Modifications apportées à la réponse :
  • Clés ajoutées : batch_id, is_realtime_enabled, processing_priority, is_demo, account, application, is_extra_error, documents > data, documents > is_moved, documents > traininglayout_fileid.
  • Clés supprimées : label, lead_time, started, delivered, deleted, wait_for_action, is_test, region, export_format, verification_type, business_unit, properties > export_format, properties > verification_type.
  • Le tableau services a été supprimé ; la clé files a été déplacée du tableau services vers le tableau documents.
  • number est désormais une chaîne de caractères au lieu d’un entier.
  • progress est désormais un nombre à virgule flottante au lieu d’un entier.

Tâches de capture de factures

POST /task/capture/invoices

POST https://api-{location-id}.flexicapture.com/v1/capture/invoices
POST https://api-{location-id}.flexicapture.com/v2/task/capture/invoices
Modifications de la requête :
  • Le corps de la requête ne doit plus contenir les clés business_unit, email et label.
  • Les clés region, export_format et verification_type ont été déplacées dans le dictionnaire properties.
Modifications de la réponse :
  • Clés ajoutées : batch_id, is_realtime_enabled, processing_priority, is_demo, account, application, is_extra_error, documents > data, documents > is_moved, documents > traininglayout_fileid.
  • Clés supprimées : label, lead_time, started, delivered, deleted, wait_for_action, is_test, region, export_format, verification_type, business_unit, properties > export_format, properties > verification_type.
  • Le tableau services a été supprimé ; la clé files a été déplacée du tableau services vers le tableau documents.
  • number est désormais une string au lieu d’un entier.
  • progress est désormais un nombre à virgule flottante au lieu d’un entier.

GET /task/

GET https://api-{location-id}.flexicapture.com/v1/task/{id}
GET https://api-{location-id}.flexicapture.com/v2/task/{id}
La réponse est désormais organisée de la même manière que pour la méthode de création de tâche.
  • Clés ajoutées, comme pour la méthode de création de tâche : 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.
  • Ajout de clés supplémentaires liées aux données extraites — documents > data > { region, export_format, verification_type, vendor_name, invoice_date, total, currency } — ainsi qu’à la facturation des tâches : billed, is_billed.
  • Clés supprimées : label, lead_time, deleted, wait_for_action, is_test, region, export_format, verification_type, business_unit.
  • Le tableau services a été supprimé ; la clé files a été déplacée du tableau services vers le tableau documents.
  • number est désormais une string au lieu d’un entier.
  • progress est désormais un nombre à virgule flottante au lieu d’un entier.

DELETE /task/

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

Utilisation des jeux de données

POST /dataset/businessunits

POST https://api-{location-id}.flexicapture.com/v1/dataset/businessunits
POST https://api-{location-id}.flexicapture.com/v2/dataset/businessunits
  • Dans la requête et dans la réponse, les clés suivantes contiennent désormais des tableaux de variantes : name, street, city, state, zip, vat.

PUT /dataset/businessunits

PUT https://api-{location-id}.flexicapture.com/v1/dataset/businessunits
PUT https://api-{location-id}.flexicapture.com/v2/dataset/businessunits
  • Dans la requête et dans la réponse, les clés suivantes contiennent désormais des tableaux de variantes : name, street, city, state, zip, vat.

GET /dataset/businessunits/

GET https://api-{location-id}.flexicapture.com/v1/dataset/businessunits/{region}
GET https://api-{location-id}.flexicapture.com/v2/dataset/businessunits/{region}
  • Des paramètres de requête facultatifs peuvent désormais être utilisés pour récupérer les données de l’une des unités commerciales : externalId, skip, take.
  • Dans la requête comme dans la réponse, les clés suivantes contiennent désormais des tableaux de variantes : name, street, city, state, zip, vat.

DELETE /dataset/businessunits/

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

DELETE /dataset/businessunit//

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 /dataset/vendors

POST https://api-{location-id}.flexicapture.com/v1/dataset/vendors
POST https://api-{location-id}.flexicapture.com/v2/dataset/vendors
  • Dans la requête comme dans la réponse, les clés suivantes contiennent désormais des tableaux de variantes : name, street, city, state, zip, vat, national_vat, iban, bank_account, bank_code, gl_code.

PUT /dataset/vendors

PUT https://api-{location-id}.flexicapture.com/v1/dataset/vendors
PUT https://api-{location-id}.flexicapture.com/v2/dataset/vendors
  • Dans la requête comme dans la réponse, les clés suivantes contiennent désormais des tableaux de variantes : name, street, city, state, zip, vat, national_vat, iban, bank_account, bank_code, gl_code.

GET /dataset/vendors/

GET https://api-{location-id}.flexicapture.com/v1/dataset/vendors/{region}
GET https://api-{location-id}.flexicapture.com/v2/dataset/vendors/{region}
  • Des paramètres de requête facultatifs peuvent désormais être utilisés pour récupérer les données de l’un des fournisseurs : externalId, skip, take.
  • Dans la requête comme dans la réponse, les clés suivantes contiennent désormais des tableaux de variantes : name, street, city, state, zip, vat, national_vat, iban, bank_account, bank_code, gl_code.

DELETE /dataset/vendors/

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

DELETE /dataset/vendors//

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

Entraînement des modèles de capture de données

POST /training

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

PUT /training

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

GET /training/layout//

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

POST /training/station/

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

PUT /training/station/

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

GET /training/batch

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