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 incluent :
  • Applications La nouvelle version 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 seront 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 : le v1 dans l’URL a été remplacé par v2.
Vous devrez modifier une partie de votre code pour tenir compte de ces différences. Les méthodes API de la première version sont répertoriées ci-dessous. Ouvrez la sous-section de chaque méthode pour voir comment elle a changé dans la deuxième version. Les modifications d’URL sont indiquées en gras.

​
Utilisation des fichiers

POST https://api-{location-id}.flexicapture.com/v2/file
  • le paramètre de requête email a été supprimé ; l’adresse e-mail du compte sera utilisée
  • ajout à la réponse : application (ID de l’application) et expiring (date d’expiration du fichier)
  • suppression dans 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 https://api-{location-id}.flexicapture.com/v2/file/{id}/{token}/info
  • pour les fichiers supprimés, il n’est plus possible de récupérer les métadonnées ; une réponse 404 est désormais renvoyée
  • ajout à la réponse : application (ID de l’application) et expiring (date d’expiration du fichier)
  • suppression dans 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 https://api-{location-id}.flexicapture.com/v2/file/{id}/{token}

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

​
Capture de documents

POST https://api-{location-id}.flexicapture.com/v2/task/capture/documents
Modifications apportées aux paramètres de 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é, et la clé files a été déplacée du tableau services vers le tableau documents
  • number est désormais de type string au lieu d’être un entier
  • progress est désormais un nombre à virgule flottante au lieu d’un entier

​
Tâches de capture de factures

POST https://api-{location-id}.flexicapture.com/v2/task/capture/invoices
Modifications apportées aux paramètres 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 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é, et la clé files a été déplacée du tableau services vers le tableau documents
  • number est désormais de type string au lieu d’être un entier
  • progress est désormais un nombre à virgule flottante au lieu d’un entier
  • les clés region, export_format et verification_type ont été déplacées dans le dictionnaire properties 
GET https://api-{location-id}.flexicapture.com/v2/task/{id}
La réponse est désormais structuré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
  • autres clés ajoutées : relatives aux données extraites documents > data > {region, export_format, verification_type, vendor_name, invoice_date, total, currency}, relatives à la facturation de la tâche : 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é, et la clé files a été déplacée du tableau services vers le tableau documents
  • number est désormais de type string au lieu d’être un entier
  • progress est désormais un nombre à virgule flottante au lieu d’un entier
  • les clés region, export_format et verification_type ont été déplacées dans le dictionnaire properties
DELETE https://api-{location-id}.flexicapture.com/v2/task/{id}

​
Utilisation des jeux de données

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 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 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, takeDans 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
DELETE https://api-{location-id}.flexicapture.com/v2/dataset/businessunits/{region}

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

POST https://api-{location-id}.flexicapture.com/v2/dataset/vendors
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, national_vat, iban, bank_account, bank_code, gl_code
PUT https://api-{location-id}.flexicapture.com/v2/dataset/vendors
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, national_vat, iban, bank_account, bank_code, gl_code
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’une des unités commerciales : externalId, skip, takeDans 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, national_vat, iban, bank_account, bank_code, gl_code
DELETE https://api-{location-id}.flexicapture.com/v2/dataset/vendors/{region}

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

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

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

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

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

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

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

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