Saltar al contenido principal

Crear una cuenta

Para interactuar con la API, necesitas una cuenta. Si aún no la has creado, hazlo a través del portal web de ABBYY FlexiCapture Cloud.

Obtener el encabezado de autorización

Todas las solicitudes a la API deben incluir un encabezado de autorización. Para obtener el encabezado de autorización:
  1. Concatene el ID de la aplicación y el token usando dos puntos como separador (encontrará el ID de la aplicación y el token en la página Applications del portal web de ABBYY FlexiCapture Cloud).
  2. Codifique la cadena resultante con cualquier variante de Base64.
  3. Agregue el método de autorización, seguido de un espacio, delante de la cadena del paso 2.
ID de la aplicación = Aladdin, token = OpenSesame
  1. Concatene el ID de la aplicación y el token:
Aladdin:OpenSesame
  1. Codifique la cadena con cualquier variante de Base64:
QWxhZGRpbjpPcGVuU2VzYW1l
  1. Agregue el método de autorización, seguido de un espacio, delante de la cadena del paso 2:
Basic QWxhZGRpbjpPcGVuU2VzYW1l
  1. El encabezado de autorización resultante tendrá este aspecto:
Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l

Cargar un archivo

Cargue un archivo al servidor. En la respuesta, obtendrá el identificador y el token del archivo. El identificador y el token se utilizarán en todas las solicitudes posteriores relacionadas con este archivo. curl -X POST —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l” “https://api-{location-id}.flexicapture.com/v2/file” —form “file=@/path/to/file/Letter.tif” location-ids compatibles: us: USA y Canadá, au: Australia, eu: países de la Unión Europea.
La configuración del proyecto para el ensamblado de documentos se ignorará al cargar un archivo mediante la REST API. Se creará un documento independiente para cada archivo.

Iniciar una tarea

Después de cargar el documento, inicie una tarea para comenzar la extracción de datos. Puede especificar varios archivos en esta solicitud. La solicitud puede contener los siguientes parámetros opcionales: invoice region, tipo de verificación y el formato de exportación de los resultados. La respuesta contendrá un identificador de tarea. curl -X POST —header “Content-Type: application/json” —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l” -d ”{ “properties”: { “region”: “US”, “export_format”: “Xls”, “verification_type”: “NoVerification”, }, “files”: [ { “id”: “5ea16ff21b777315586713bf”, “token”: “34FB84AA68684F0F2BF496045224EB6C436F596B” } ] }” “https://api-{location-id}.flexicapture.com/v2/task/capture/invoices location-ids compatibles: us: USA y Canadá, au: Australia, eu: los países de la Unión Europea.

Obtener el estado de la solicitud

El procesamiento de la tarea llevará algo de tiempo, por lo que los datos extraídos no estarán disponibles de inmediato. Puede comprobar el estado de la tarea con el identificador que recibió al iniciar la tarea. Espere hasta que el estado cambie a Done. curl -X GET —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l” “https://api-{location-id}.flexicapture.com/v2/task/5ea18adc220e0d1c58177c59 location-ids compatibles: us: USA y Canadá, au: Australia, eu: los países de la Unión Europea.

Descargar el resultado

Después de que el status de la tarea cambie a Done, puede descargar los archivos de salida usando sus identificadores y tokens. Esta request puede repetirse para cada archivo de entrada de la request de la tarea. curl -X GET —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l=” “https://api-{location-id}.flexicapture.com/v2/file/5ea21f6b7a9ae6193831d671/D188E5EFC0042A83529899AC1E1D94400A25DCF6 location-ids compatibles: us: USA y Canadá, au: Australia, eu: los países de la Unión Europea.

Eliminar tarea

Después de descargar los datos de salida, elimine la tarea para quitar todos los archivos de entrada y de salida. curl -X DELETE —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l=” “https://api-{location-id}.flexicapture.com/v2/task/5ea18adc220e0d1c58177c59 location-ids compatibles: us: USA y Canadá, au: Australia, eu: los países de la Unión Europea.