Saltar al contenido principal
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 incluyen:
  • Aplicaciones La nueva versión 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 representarán 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.
Tendrá que cambiar parte de su código para tener en cuenta las diferencias. Los métodos de la API de la primera versión se enumeran a continuación. Abra la subsección de cada método para ver cómo ha cambiado en la segunda versión. Los cambios en la URL están marcados en negrita.

​
Trabajo con archivos

POST https://api-{location-id}.flexicapture.com/v2/file
  • se eliminó el parámetro de consulta email; se usará 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 expiración del archivo)
  • se eliminaron de la respuesta las claves relacionadas con la validación y 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 https://api-{location-id}.flexicapture.com/v2/file/{id}/{token}/info
  • en el caso de los archivos eliminados, ya no es posible obtener metadatos; ahora se devuelve una respuesta 404
  • se añadieron a la respuesta: application (ID de la aplicación) y expiring (la fecha de expiración del archivo)
  • se eliminaron de la respuesta las claves relacionadas con la validación y 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 https://api-{location-id}.flexicapture.com/v2/file/{id}/{token}

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

​
Captura de documentos

POST https://api-{location-id}.flexicapture.com/v2/task/capture/documents
Cambios en los parámetros de la solicitud:
  • el cuerpo de la solicitud ya no debe contener las claves 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 eliminó el array services y 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 punto flotante en lugar de un entero

​
Tareas de captura de facturas

POST https://api-{location-id}.flexicapture.com/v2/task/capture/invoices
Cambios en los parámetros de 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 movieron 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 y 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 punto flotante en lugar de un entero
  • las claves region, export_format y verification_type se movieron al diccionario properties 
GET https://api-{location-id}.flexicapture.com/v2/task/{id}
La respuesta ahora se organiza de la misma manera que en el método de creación de tareas.
  • claves agregadas, 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 agregaron más claves: relacionadas con los datos extraídos documents > data > {region, export_format, verification_type, vendor_name, invoice_date, total, currency}, relacionadas con la facturación de tareas: billed, is_billed
  • claves eliminadas: label, lead_time, deleted, wait_for_action, is_test, region, export_format, verification_type, business_unit,
  • se eliminó el array services y 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 punto flotante en lugar de un entero
  • las claves region, export_format y verification_type se movieron al diccionario properties
DELETE https://api-{location-id}.flexicapture.com/v2/task/{id}

​
Trabajar con conjuntos de datos

POST https://api-{location-id}.flexicapture.com/v2/dataset/businessunits
Tanto en la solicitud como en la respuesta, las siguientes claves ahora contienen arrays de variantes: name, street, city, state, zip, vat
PUT https://api-{location-id}.flexicapture.com/v2/dataset/businessunits
Tanto en la solicitud como en la respuesta, las siguientes claves ahora contienen arrays de variantes: name, street, city, state, zip, vat
GET https://api-{location-id}.flexicapture.com/v2/dataset/businessunits/{region}
Ahora pueden usarse parámetros de consulta opcionales para obtener los datos de una de las unidades de negocio: externalId, skip, takeTanto en la solicitud como en la respuesta, las siguientes claves ahora contienen arrays 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
Tanto en la solicitud como en la respuesta, las siguientes claves ahora contienen arrays 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
Tanto en la solicitud como en la respuesta, las siguientes claves ahora contienen arrays 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}
Ahora pueden usarse parámetros de consulta opcionales para obtener los datos de una de las unidades de negocio: externalId, skip, takeTanto en la solicitud como en la respuesta, las siguientes claves ahora contienen arrays 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}

​
Entrenamiento de los modelos de captura de datos

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}