Referencia de la API

La API de ABBYY FlexiCapture for Invoices Cloud se basa en REST. La API le permite acceder a los recursos del servicio ABBYY FlexiCapture Cloud. Después de registrarse y obtener el encabezado de autenticación, puede realizar solicitudes a la API de ABBYY FlexiCapture for Invoices Cloud. La API utiliza funcionalidades HTTP integradas, como la autenticación HTTP y los verbos HTTP, que son compatibles con los clientes HTTP estándar. El portal web de ABBYY FlexiCapture Cloud incluye la definición de la API en formato Swagger. Puede usarla para generar código de cliente en el lenguaje que utilice para su proyecto mediante herramientas específicas, por ejemplo Swagger Editor.

Endpoint de la API

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

Reemplace {location-id} por una de las ubicaciones compatibles:

us: USA y Canadá
au: Australia
eu: los países de la Unión Europea

Recursos REST

Las rutas de endpoint que se muestran a continuación son relativas al endpoint de la API descrito anteriormente.

v2.file

Método	Endpoint	Descripción
Cargar	`POST /v2/file`	Carga uno o varios archivos en la nube.
Descargar	`GET /v2/file/{id}/{token}`	Descarga un archivo de la nube.
Obtener	`GET /v2/file/{id}/{token}/info`	Devuelve los metadatos del archivo.
Eliminar	`DELETE /v2/file/{id}/{token}`	Elimina un archivo de la nube.

v2.task

Método	Endpoint	Descripción
Ejecutar	`POST /v2/task/capture/invoices`	Ejecuta una tarea de captura de facturas.
Obtener	`GET /v2/task/{id}`	Obtiene información de la tarea por su ID.
Eliminar	`DELETE /v2/task/{id}`	Elimina los datos de la tarea por su ID.

v2.dataset

Método	Endpoint	Descripción
Crear unidad de negocio	`POST /v2/dataset/businessunits`	Crea una lista de unidades de negocio.
Actualizar unidad de negocio	`PUT /v2/dataset/businessunits`	Actualiza la información de las unidades de negocio en el conjunto de datos.
Obtener unidad de negocio	`GET /v2/dataset/businessunits/{region}`	Devuelve una lista de unidades de negocio de la región especificada.
Eliminar unidad de negocio por región	`DELETE /v2/dataset/businessunits/{region}`	Elimina del conjunto de datos las unidades de negocio de la región especificada.
Eliminar unidad de negocio por ID	`DELETE /v2/dataset/businessunit/{region}/{externalId}`	Elimina del conjunto de datos una unidad de negocio con el ID externo especificado.
Crear proveedor	`POST /v2/dataset/vendors`	Crea una lista de proveedores.
Actualizar proveedor	`PUT /v2/dataset/vendors`	Actualiza la información de los proveedores en el conjunto de datos.
Obtener proveedor	`GET /v2/dataset/vendors/{region}`	Devuelve una lista de proveedores de la región especificada.
Eliminar proveedor por región	`DELETE /v2/dataset/vendors/{region}`	Elimina del conjunto de datos los proveedores de la región especificada.
Eliminar proveedor por ID	`DELETE /v2/dataset/vendor/{region}/{externalId}/{businessUnitId}`	Elimina del conjunto de datos un proveedor con el ID externo especificado.

v2.training

Método	Endpoint	Descripción
Entrenar	`POST /v2/training`	Entrena un modelo de captura de datos.
Layout	`GET /v2/training/layout/{taskId}/{fileId}`	Obtiene la estructura de los datos capturados.

Administrator's Guide

Administration Guide

Performance Guide

Troubleshooting

Cloud

Endpoint de la API

Recursos REST

v2.file

v2.task

v2.dataset

v2.training

​Endpoint de la API

​Recursos REST

​v2.file

​v2.task

​v2.dataset

​v2.training

Endpoint de la API

Recursos REST

v2.file

v2.task

v2.dataset

v2.training