Saltar al contenido principal
Un escenario típico para procesar documentos utilizando una sola llamada a la 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. Para obtener más información, consulte Authentication. Utilice este escenario si tiene un archivo de menos de 30 MB de tamaño y no necesita editar las imágenes del archivo.

​
Paso 1. Obtener una lista de todas las skills disponibles

Para obtener una lista de todas las skills disponibles, envíe una solicitud GET al recurso skills: Ejecute el siguiente comando: Como resultado, recibirá información sobre todas las skills añadidas a la instancia de la aplicación.

​
Paso 2. Crear e iniciar una transacción

Para crear e iniciar una transacción, envíe una solicitud POST al recurso transactions/launch: En la URL, especifique el parámetro de consulta skillId (devuelto por la llamada a la API anterior). En el cuerpo de la solicitud, envíe el archivo que desea procesar junto con metadatos opcionales. También puede incluir registrationParameters y skillParameters opcionales en el cuerpo de la solicitud. A continuación se muestra un ejemplo del cuerpo de la solicitud: 
{
  "files": [
    {
    }
  ]
}
Ejecute el siguiente comando: Como resultado, recibirá una respuesta que contiene el id de la transacción creada.

​
Paso 3. Supervisar el estado de la transacción

Para ello, envíe una solicitud GET al recurso transactions: Ejecute el siguiente comando: Como resultado, recibirá una respuesta que contiene el estado de la transacción. El procesamiento de la transacción puede estar en uno de los siguientes estados:
  • New. La transacción se creó, pero aún no se ha puesto en cola para su procesamiento.
  • Queued. La transacción está en cola para su procesamiento.
  • InProgress. La transacción se está procesando.
  • Processed. La transacción se procesó correctamente.
  • ProcessedWithWarnings. La transacción se procesó, pero se produjeron advertencias.
  • NotProcessed. La transacción no se procesó debido a un error.
  • Deleted. La transacción fue eliminada por el usuario o automáticamente por la política de retención.
Si el estado de la transacción es Processed o ProcessedWithWarnings, vaya al paso 4.

​
Paso 4. Descarga de archivos de origen y de resultados

Para descargar los archivos de origen y de resultados, envíe una solicitud GET al recurso transactions/files/download, donde debe especificar el ID del archivo recibido en la solicitud anterior: Ejecute el siguiente comando: