Skip to main content
Cuando actualice de la versión 1 a la versión 2 de ABBYY FlexiCapture for Invoices Cloud REST API, tendrá que hacer algunos cambios en su código. Los cambios esenciales son:
  • Aplicaciones — La versión 2 introduce el concepto de aplicaciones. Una cuenta puede tener varias aplicaciones que funcionan de forma independiente. Cada aplicación solo puede trabajar con sus propias tareas, datos de procesamiento y modelos de entrenamiento, y no puede acceder a esa información de otras aplicaciones.
  • Campos multicolumna — Ahora los campos pueden tener variantes, lo que permite diferencias ortográficas y errores, y facilita hacer coincidir los proveedores y las unidades de negocio. Los campos capturados se representan mediante arrays con variantes.
  • Versión actualizada en las URL — Se cambió el nombre de las URL según la versión: v1 en la URL pasó a ser v2.
A continuación se enumeran por categoría los métodos de la API de la versión 1. Cada entrada muestra la URL de la versión 2 y los cambios en su solicitud y respuesta.

Trabajo con archivos

POST /file

  • Se eliminó el parámetro de consulta email; en su lugar, se usa la dirección de correo electrónico de la cuenta.
  • Se añadieron a la respuesta: application (ID de la aplicación) y expiring (la fecha de caducidad del archivo).
  • Se eliminaron de la respuesta las claves relacionadas con la validación y la eliminación del archivo (validated, is_validated, deleted, is_deleted), el mensaje de error (error) y el número de páginas (pages_count).

GET /file///info

  • En los archivos eliminados, ya no se pueden obtener metadatos; ahora se devuelve una respuesta 404.
  • Se añadió a la respuesta: application (ID de la aplicación) y expiring (la fecha de vencimiento del archivo).
  • Se eliminó de la respuesta: las claves relacionadas con la validación y la eliminación de archivos (validated, is_validated, deleted, is_deleted), el mensaje de error (error) y el número de páginas (pages_count).

GET /file//

DELETE /file//

Captura de documentos

POST /task/capture/documents

Cambios en la solicitud:
  • El cuerpo de la solicitud ya no debe incluir las claves email y label.
  • Las claves region, export_format y verification_type se trasladan al diccionario properties.
Cambios en la respuesta:
  • Claves agregadas: batch_id, is_realtime_enabled, processing_priority, is_demo, account, application, is_extra_error, documents > data, documents > is_moved, documents > traininglayout_fileid.
  • Claves eliminadas: label, lead_time, started, delivered, deleted, wait_for_action, is_test, region, export_format, verification_type, business_unit, properties > export_format, properties > verification_type.
  • Se eliminó el array services; la clave files se movió del array services al array documents.
  • number ahora es una cadena en lugar de un entero.
  • progress ahora es un número de coma flotante en lugar de un entero.

Tareas de captura de facturas

POST /task/capture/invoices

Cambios en la solicitud:
  • El cuerpo de la solicitud ya no debe contener las claves business_unit, email y label.
  • Las claves region, export_format y verification_type se han movido al diccionario properties.
Cambios en la respuesta:
  • Claves añadidas: batch_id, is_realtime_enabled, processing_priority, is_demo, account, application, is_extra_error, documents > data, documents > is_moved, documents > traininglayout_fileid.
  • Claves eliminadas: label, lead_time, started, delivered, deleted, wait_for_action, is_test, region, export_format, verification_type, business_unit, properties > export_format, properties > verification_type.
  • Se ha eliminado el array services; la clave files se ha movido del array services al array documents.
  • number ahora es una cadena en lugar de un entero.
  • progress ahora es un número de coma flotante en lugar de un entero.

GET /task/

La respuesta ahora está organizada de la misma manera que para el método de creación de tareas.
  • Se añadieron claves, similares a las del método de creación de tareas: 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.
  • Se añadieron más claves relacionadas con los datos extraídos — documents > data > { region, export_format, verification_type, vendor_name, invoice_date, total, currency } — y con la facturación de tareas: billed, is_billed.
  • Se eliminaron las claves: label, lead_time, deleted, wait_for_action, is_test, region, export_format, verification_type, business_unit.
  • Se eliminó el array services; la clave files se movió del array services al array documents.
  • number ahora es una cadena en lugar de un entero.
  • progress ahora es un número de coma flotante en lugar de un entero.

DELETE /task/

Trabajar con conjuntos de datos

POST /dataset/businessunits

  • Tanto en la solicitud como en la respuesta, las siguientes claves ahora contienen array con variantes: name, street, city, state, zip, vat.

PUT /dataset/businessunits

  • Tanto en la solicitud como en la respuesta, las siguientes claves ahora contienen array con variantes: name, street, city, state, zip, vat.

GET /dataset/businessunits/

  • Ahora se pueden usar parámetros de consulta opcionales para obtener los datos de una unidad de negocio: externalId, skip, take.
  • Tanto en la solicitud como en la respuesta, las siguientes claves ahora contienen arrays con variantes: name, street, city, state, zip, vat.

DELETE /dataset/businessunits/

DELETE /dataset/businessunit//

POST /dataset/vendors

  • Tanto en la solicitud como en la respuesta, las siguientes claves contienen ahora arrays con variantes: name, street, city, state, zip, vat, national_vat, iban, bank_account, bank_code, gl_code.

PUT /dataset/vendors

  • Tanto en la solicitud como en la respuesta, las siguientes claves ahora contienen arrays con variantes: name, street, city, state, zip, vat, national_vat, iban, bank_account, bank_code, gl_code.

GET /dataset/vendors/

  • Ahora se pueden usar parámetros de consulta opcionales para obtener los datos de uno de los proveedores: externalId, skip, take.
  • Tanto en la solicitud como en la respuesta, las siguientes claves contienen ahora arrays con variantes: name, street, city, state, zip, vat, national_vat, iban, bank_account, bank_code, gl_code.

DELETE /dataset/vendors/

DELETE /dataset/vendors//

Entrenamiento de los modelos de captura de datos

POST /training

PUT /training

GET /training/layout//

POST /training/station/

PUT /training/station/

GET /training/batch