Saltar al contenido principal

​
Flujo de trabajo de la API REST

El flujo de trabajo típico de la API REST es el siguiente:
Diagrama del flujo de trabajo típico de API REST de ABBYY FlexiCapture Cloud, que muestra los pasos desde la carga de archivos y la creación de una tarea hasta la consulta del estado, la obtención de resultados para la verificación, la verificación personalizada y el entrenamiento opcionales, y la eliminación de los archivos de entrada y salida.
Cualquier proyecto de FlexiCapture que vaya a utilizarse con una aplicación basada en la API REST debe incluir un flujo de trabajo correctamente configurado. Las instrucciones siguientes muestran cómo adaptar el flujo de trabajo del proyecto de ejemplo Banking Card Application para usarlo con la API REST. Para obtener más información sobre los proyectos de ejemplo, consulte ABBYY FlexiCapture sample projects. Antes de continuar con esta guía, inicie Project Setup Station y abra el proyecto de ejemplo Banking Card Application (la ubicación predeterminada es C:\Users\Public\ABBYY\FlexiCapture\12.0\Samples\FlexiCapture\English\Banking_eng\banking_eng.fcproj).

​
Ajustar las etapas del flujo de trabajo

La API REST siempre envía los datos para su procesamiento como el tipo de lote “Predeterminado”. Por este motivo, todo el procesamiento de documentos del proyecto debe configurarse para el tipo de lote “Predeterminado”.
1

Seleccione el esquema de flujo de trabajo Advanced

En el menú Proyecto, haga clic en Propiedades del proyecto y, a continuación, en la pestaña Flujo de trabajo. En la lista desplegable Esquema, seleccione Advanced y modifique la configuración del flujo de trabajo como se muestra a continuación.
Captura de pantalla de la pestaña Flujo de trabajo en el cuadro de diálogo Propiedades del proyecto de ABBYY FlexiCapture Project Setup Station, que muestra el esquema Advanced seleccionado con sus etapas de flujo de trabajo.
2

Habilite las estaciones web para la verificación

Haga clic en Verificación → General y seleccione la opción Habilitar estaciones web.Nota: Puede omitir esta configuración si no necesita una etapa de verificación en su proyecto.
3

Establezca la condición de entrada de la verificación

Haga clic en Verificación → Condiciones de entrada y establezca la opción Los documentos se admiten en la etapa en Siempre.
Según los requisitos de su solución, es posible que desee deshabilitar temporalmente la etapa de verificación o hacerlo de forma condicional mediante una regla basada en scripts en la pestaña Condiciones de entrada.
Captura de pantalla de la pestaña Condiciones de entrada de una etapa de verificación en ABBYY FlexiCapture Project Setup Station, que muestra la opción Los documentos se admiten en la etapa establecida en Siempre.
4

Agregue una etapa para exportar el diseño XML

Para habilitar el endpoint training/layout/{taskId}/{fileId} para su proyecto, exporte el archivo XML que contiene los datos de los campos y el diseño. Cree una etapa de procesamiento de documentos inmediatamente antes de la etapa de verificación.
Captura de pantalla de las etapas del flujo de trabajo en ABBYY FlexiCapture Project Setup Station, con una nueva etapa de procesamiento de documentos agregada inmediatamente antes de la etapa de verificación.
5

Establezca la condición de entrada de la nueva etapa

En la pestaña Condiciones de entrada, elija Siempre.
Captura de pantalla de la pestaña Condiciones de entrada de la nueva etapa de procesamiento en ABBYY FlexiCapture Project Setup Station, con la condición de admisión establecida en Siempre.
6

Abra el editor de scripts

En la pestaña Script, haga clic en Editar script….
Captura de pantalla de la pestaña Script de una etapa de procesamiento en ABBYY FlexiCapture Project Setup Station, con el botón Editar script.
7

Establezca el idioma del script

Cambie el idioma del script a C# .NET.
Captura de pantalla del editor de scripts en ABBYY FlexiCapture Project Setup Station, con el idioma del script establecido en C# .NET.
8

Agregue el script de exportación

Copie y pegue el siguiente fragmento de código en el panel de scripts:
using System;
Document.SaveXmlToFileStorage();
9

Guarde los cambios

Haga clic en OK para guardar los cambios.
La configuración de ensamblado de documentos del proyecto (Procesamiento de imágenes → Crear documento) se ignora al cargar archivos mediante la API REST. Se crea un documento distinto para cada archivo.

​
Ajustar la configuración de exportación de datos

Una vez procesado un lote enviado a través de la API REST, la API REST recupera los archivos exportados para ponerlos a disposición del cliente para su descarga.
ABBYY FlexiCapture Cloud almacena los archivos exportados en un almacenamiento de objetos. Por esta razón, no debe usar rutas de exportación absolutas en su proyecto de API REST.
Los proyectos de API REST no requieren ninguna estructura de carpetas especial. Puede usar una estructura de carpetas plana, con el nombre de la carpeta raíz para cada lote y los ID de los documentos como parte de los nombres de archivo. Los servicios de la API REST asignan a cada lote enviado a través de la API REST un nombre de lote único y aleatorio, de modo que se generan nombres de archivo únicos al exportar datos de esos lotes. La siguiente captura de pantalla muestra la configuración de exportación original, que da como resultado una estructura de carpetas de varios niveles:
Captura de pantalla de la configuración de exportación en Project Setup Station de ABBYY FlexiCapture, que muestra la nomenclatura de archivos original que genera una estructura de carpetas de varios niveles.
La siguiente captura de pantalla muestra la configuración de exportación modificada, que da como resultado una estructura de carpetas plana:
Captura de pantalla de la configuración de exportación en Project Setup Station de ABBYY FlexiCapture, que muestra la nomenclatura de archivos modificada que genera una estructura de carpetas plana.

​
Cargue su proyecto modificado en ABBYY FlexiCapture Cloud

1

Abra el cuadro de diálogo de carga

Haga clic en Archivo > Upload Project to Server… para cargar su proyecto en ABBYY FlexiCapture Cloud.
2

Introduzca el servidor y el tenant

En el cuadro de diálogo que se abre, introduzca la URL del servidor en la nube que aloja su tenant e indique el nombre de su tenant.
3

Introduzca sus credenciales

Seleccione Use server authentication e introduzca las credenciales de administrador de su tenant.
4

Pruebe la conexión

Haga clic en Test connection para comprobar la configuración de conexión.
5

Cargue el proyecto

Haga clic en OK y espere a que se cargue el proyecto.

​
Próximos pasos

Una vez que haya cargado su proyecto en ABBYY FlexiCapture Cloud, esto es lo que puede probar a continuación: