Skip to main content
Un escenario típico para procesar documentos utilizando una sola llamada de API (para crear una transacción, cargar un archivo e iniciar una transacción) consta de los siguientes pasos:
  1. Recibir una lista de todas las skills disponibles
  2. Crear e iniciar una transacción
  3. Supervisar el estado de la transacción
  4. Descargar los archivos de origen y de resultados
Cada solicitud al servidor debe incluir información de autenticación. Consulte Authentication para obtener más información. Utilice este escenario si solo tiene un archivo de menos de 30 MB de tamaño y no necesita editar las imágenes del archivo.

​
Obtención de una lista de todos los skills disponibles

Para ello, envía una solicitud GET al recurso skills:
Ejecuta el siguiente comando: Para Windows:
Para Linux:
La respuesta contendrá un archivo JSON similar al siguiente: Respuesta:
Defina el identificador de la skill que va a usar. Puede encontrar descripciones detalladas de las skills en las skills integradas.

​
Crear e iniciar una transacción

Para crear e iniciar una transacción que procese un archivo cargado con una skill específica, envíe la siguiente solicitud POST al recurso transactions/launch?skillId=<skill-id>:
Esto creará e iniciará de inmediato una nueva transacción. Ejecute el siguiente comando: Para Windows:
Para Linux:
Al cargar el archivo en Vantage, todos los caracteres siguientes del nombre de archivo se reemplazarán por un guion bajo: :/?#[]@!$&'()*+,;=\. El nombre de archivo modificado se mostrará tanto en Vantage API como en Skill Monitor.

​
Supervisión del estado de la transacción

Para supervisar el estado de la transacción mediante un bucle con un intervalo breve (no recomendamos comprobar el estado más de una vez por segundo), envíe una solicitud GET al recurso transactions/<transaction_id> e incluya el identificador de la transacción en el URI de la solicitud:
Ejecute el siguiente comando: Para Windows:
Para Linux:
La respuesta tendrá un aspecto similar al siguiente: Respuesta:
En la respuesta:
  • Si el valor de la clave status es Processing, los resultados todavía no están listos. Cuando el estado de la transacción cambie a Processed, podrá descargar los resultados.
  • La clave manualReviewLink contendrá un enlace a la interfaz web del cliente de revisión manual y un token de acceso de Vantage, si se requiere revisión manual. Este enlace y el token pueden usarse para revisar y corregir los resultados de clasificación y extracción de campos de una transacción concreta. Hasta que se complete la revisión, el valor de la clave status será Processing. El enlace proporcionado es válido durante 168 horas; transcurrido ese tiempo, deberá crearse y obtenerse un nuevo enlace para otro período de 168 horas usando el mismo método. Consulte más información en Integrating manual review.
Los usuarios autorizados mediante este enlace no pueden ver ni modificar ningún otro documento ni transacción.
Para una Skill de documento, la respuesta tendrá ahora un aspecto similar al siguiente: Respuesta:
En el array documents, cada documento tiene un array resultFiles. Utilice este array para obtener los valores fileId. El formato de los archivos de salida lo define la skill que utilice. Actualmente, todas las skills devuelven los campos extraídos en formato JSON. Para una Skill de clasificación, la respuesta recibida después de que se hayan procesado los documentos tendrá un aspecto similar al siguiente: Respuesta:
Extraiga la clase del documento de la clave resultClass.name y compruebe la confianza de cada clase probable en las claves confidence (un entero de 0 a 100). Para una Habilidad de proceso, la respuesta puede contener toda o parte de la información que se devuelve para las Skills de documento y de clasificación, según las etapas disponibles en la Habilidad de proceso.

​
Descarga de archivos de origen y archivos de resultados

Una vez finalizado el procesamiento, puede descargar dos tipos de archivo:
  • Archivos de origen — los archivos originales que cargó, devueltos en su formato binario original.
  • Archivos de resultados — la salida del procesamiento: los datos extraídos, en formato JSON de forma predeterminada (el formato de salida lo establece la skill).
Los archivos de origen y los archivos de resultados usan endpoints e identificadores de archivo distintos:
  • Archivo de origen — GET transactions/<transaction-id>/documents/<document-id>/sourceFiles/<file-id>/download. El ID del archivo proviene de la respuesta de GET transactions/<transaction-id>/documents (sourceFiles[].id).
  • Archivo de resultados — GET transactions/<transaction-id>/files/<file-id>/download. El ID del archivo proviene del array resultFiles de la respuesta de estado de la transacción (documents[].resultFiles[].fileId).
Para solicitar una lista de documentos con sus identificadores, envíe una solicitud GET al recurso transactions/<transaction-id>/documents y especifique el identificador de la transacción:
Ejecute el siguiente comando: Para Windows:
Para Linux:

​
Archivos de origen

Para descargar un archivo de origen necesario, envíe una solicitud GET al recurso transactions/<transaction-id>/documents/<document-id>/sourceFiles/<file-id>/download y especifique los identificadores de la transacción, el documento y el archivo (obtenidos en la última respuesta):
Ejecute el siguiente comando: Para Windows:
Para Linux:
La respuesta contendrá el archivo en formato binario. Repita este paso para todos los archivos de origen.

​
Archivos de resultados

Para descargar un archivo de resultados, envíe una solicitud GET al recurso transactions/<transaction-id>/files/<file-id>/download y especifique el identificador de la transacción y el fileId del archivo de resultados. Obtenga el fileId del array resultFiles que se devuelve al supervisar el estado de la transacción (cada entrada tiene un fileId y un type, como Json):
Ejecute el siguiente comando: Para Windows:
Para Linux: