- Obtenga el encabezado de autorización con las credenciales de una de sus aplicaciones. Para obtener más información sobre cómo obtener el encabezado de autorización, consulte la sección Autenticación.
- Cargue un archivo en un formato de entrada válido en el servidor mediante el método File.Upload. En la respuesta, obtendrá el identificador y el token del archivo, que se utilizarán en todas las solicitudes posteriores relacionadas con este.
Ejemplo de solicitud
Ejemplo de solicitud
curl -X POST —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l” “https://api-eu.flexicapture.com/v2/file” —form “file=@/path/to/file/US_1.png”
Ejemplo de respuesta
Ejemplo de respuesta
{“id”: “5eeb762149c6470fdc65a84c”,“token”: “4B5A1A00E7A82C2AF31E20CADE7284DDA43DED30”,“name”: “US_1.png”,“extension”: “.png”,“hash”: “E75133BA4FC50B7197C2842D7A8A8AE615C37E38714C7773B1F8E2904EC62537A199129CD3B737673FBAB1DE63CBD5D428705443ADD2E1BA6223B7DD60070FDA”,“size”: 369090,“mime”: “image/png”,“is_recognizable”: true,“account”: “5dae591d3c66a51ae8be9896”,“application”: “5dae591e91375010bcd78362”,“email”: “user@abbyy.com”,“created”: “2020-02-02T14:11:45.5338461Z”,“expiring”: “2020-03-03T14:11:45.5338254Z”}
- Inicie una tarea de procesamiento para comenzar la extracción de datos mediante el método Task.Run. Puede especificar varios archivos en esta solicitud. La solicitud puede contener los siguientes parámetros opcionales: región de las facturas, tipo de verificación y formato de exportación para los resultados.
Ejemplo de solicitud
Ejemplo de solicitud
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”: “5eeb762149c6470fdc65a84c”,“token”: “4B5A1A00E7A82C2AF31E20CADE7284DDA43DED30”}]}” “https://api-eu.flexicapture.com/v2/task/capture/invoices”
Ejemplo de respuesta
Ejemplo de respuesta
{“id”: “5eeb7bf728613d1e04a70782”,“number”: “1126563”,“batch_id”: 0,“type”: “ic”,“is_realtime_enabled”: false,“processing_priority”: “Normal”,“is_demo”: false,“properties”: {“region”: “US”,“export_format”: “Xls”,“verification_type”: “NoVerification”},“account”: “5dae591d3c66a51ae8be9896”,“email”: “user@abbyy.com”,“application”: “5dae591e91375010bcd78362”,“created”: “2020-02-02T14:36:39.441Z”,“progress”: 0,“status”: “Submitted”,“is_deleted”: false,“is_billed”: false,“documents”: [{“files”: {“source”: {“id”: “5eeb762149c6470fdc65a84c”,“token”: “4B5A1A00E7A82C2AF31E20CADE7284DDA43DED30”,“name”: “US_1.png”}},“data”: {},“is_moved”: false}],“is_extra_error”: false}
- El procesamiento de la tarea tardará algún tiempo, por lo que los datos extraídos no estarán disponibles de inmediato. Puede consultar el estado de la tarea con el identificador que recibió al iniciarla. Espere hasta que el estado cambie a Done. Para consultar el estado de la tarea, use el método Task.Get.
Ejemplo de solicitud
Ejemplo de solicitud
curl -X GET —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l” “https://api-eu.flexicapture.com/v2/task/5eeb7bf728613d1e04a70782
Ejemplo de respuesta
Ejemplo de respuesta
{“id”: “5eeb7bf728613d1e04a70782”,“number”: “1126563”,“batch_id”: 2640691,“type”: “ic”,“is_realtime_enabled”: false,“processing_priority”: “Normal”,“is_demo”: false,“properties”: {“region”: “US”,“export_format”: “Xls”,“verification_type”: “NoVerification”},“account”: “5dae591d3c66a51ae8be9896”,“email”: “user@abbyy.com”,“application”: “5dae591e91375010bcd78362”,“created”: “2020-02-02T14:36:39.441Z”,“started”: “2020-02-02T14:36:50.308Z”,“billed”: “2020-02-02T14:37:14.35Z”,“delivered”: “2020-02-02T14:37:14.328Z”,“progress”: 100,“status”: “Done”,“is_deleted”: false,“is_billed”: true,“documents_count”: 1,“pages_count”: 1,“documents”: [{“files”: {“source”: {“id”: “5eeb762149c6470fdc65a84c”,“token”: “4B5A1A00E7A82C2AF31E20CADE7284DDA43DED30”,“name”: “US_1.png”},“target”: {“id”: “5eeb7c1963ee5a1268123b96”,“token”: “A01EFC05BBB787DC6825F08E51B56CF3E066210E”,“name”: “Data_00000001.xls”},“verification_layer_page_0”: {“id”: “5eeb7c1a63ee5a1268123b97”,“token”: “18921FFB4C944056CB3ED00768F90724ADF0CB69”,“name”: “verification_layer_page_2.xml”}},“data”: {“region”: “us”,“export_format”: “xls”,“verification_type”: “noverification”,“vendor_id”: “1”,“vendor_name”: “AA APPAREL”,“total”: “20208”,“currency”: “USD”},“is_moved”: false}],“is_extra_error”: false}
- Después de que el estado cambie a Done, puede descargar los archivos de salida usando sus identificadores y tokens (información de los archivos target en la respuesta del paso anterior). Para ello, use el método File.Download. Esta solicitud puede repetirse para cada archivo de entrada de la solicitud de la tarea.
Ejemplo de solicitud
Ejemplo de solicitud
curl -X GET —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l=” “https://api-eu.flexicapture.com/v2/file/5eeb7c1963ee5a1268123b96/A01EFC05BBB787DC6825F08E51B56CF3E066210E”
- Después de descargar los datos de salida, elimine la tarea para quitar todos los archivos de entrada y salida. Para ello, use el método Task.Delete y especifique el identificador de la tarea.
Ejemplo de solicitud
Ejemplo de solicitud
curl -X DELETE —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l=” “https://api-eu.flexicapture.com/v2/task/5eeb7bf728613d1e04a70782”
