Saltar al contenido principal
Un escenario típico para procesar documentos con llamadas API separadas (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 una transacción vacía
  3. Agregar un conjunto de archivos para procesar en la transacción
  4. Iniciar la transacción
  5. Supervisar el estado de la transacción
  6. Descargar los archivos de origen y los archivos de resultados
Cada solicitud al servidor debe incluir información de autenticación (como un token de acceso). Para obtener más información, consulta Authentication.

​
Obtener una lista de todas las skills disponibles

Para ello, envía una solicitud GET al recurso skills: 
GET https://your-server/api/publicapi/v1/skills
Ejecute el siguiente comando: En Windows: 
curl -X GET "https://your-server/api/publicapi/v1/skills" \
-H "Authorization: Bearer token"
En Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/skills' \
-H 'Authorization: Bearer token'
Como resultado, recibirá información sobre todas las skills añadidas a la instancia de la aplicación.

​
Creación de una transacción vacía

Para ello, envíe la siguiente solicitud POST al recurso transactions: 
POST https://tu-servidor/api/publicapi/v1/transactions
Ejecute el siguiente comando: Para Windows: 
curl -X POST "https://tu-servidor/api/publicapi/v1/transactions" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json" \
-d "{
  \"skillId\": \"00000000-0000-0000-0000-000000000001\"
}"
Para Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{
  "skillId": "00000000-0000-0000-0000-000000000001"
}'
En el cuerpo de la solicitud, indique el Parameter skillId, que fue devuelto por la llamada a la API anterior. Como resultado, recibirá una respuesta que incluye el id de la transacción creada.

​
Añadir un conjunto de archivos para procesar en la transacción

¡Importante! El número máximo de archivos en una transacción es de 1000. Un conjunto de archivos se puede añadir de dos maneras:

​
Añadir archivos directamente a la transacción

Para ello, envíe una solicitud POST al recurso transactions/<transaction-id>/files: 
POST https://su-servidor/api/publicapi/v1/transactions/id-de-transacción/files
En el cuerpo de la solicitud, envíe el archivo que se va a procesar. Para obtener información sobre los Parameter disponibles para personalizar archivos, consulte la Referencia de la API. Ejecute el siguiente comando: Para Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/files" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
Para Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/files' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'
Como resultado, recibirá una respuesta con una lista de los archivos añadidos y sus identificadores. Puede añadir tantos archivos como necesite repitiendo esta llamada varias veces. Opciones adicionales para la carga de archivos:

​
Agregar archivos a un documento

Primero, cree un documento enviando una solicitud POST al recurso transactions/<transaction-id>/documents: 
POST https://your-server/api/publicapi/v1/transactions/transaction-id/documents
Para Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/documents" \
-H "Accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json" \
-d "{
  \"documents\": [
    {
    }
  ]
}"
En Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{
  "documents": [
    {
    }
  ]
}'
Como resultado, recibirá una respuesta con el identificador del documento. Luego, agregue archivos al documento enviando una solicitud POST al recurso transactions/<transaction-id>/documents/<document-id>/sourceFiles: 
POST https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles
Para Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
En Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'

​
Iniciar la transacción

Para iniciar la transacción con la skill y los archivos especificados, envíe la siguiente solicitud POST al recurso transactions/<transaction-id>/start: 
POST https://su-servidor/api/publicapi/v1/transactions/transaction-id/start
Para Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/start" \
-H "accept: */*" \
-H "Authorization: Bearer token"
En Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/start' \
-H 'accept: */*' \
-H 'Authorization: Bearer token'

​
Supervisar el estado de la transacción

Para empezar a supervisar el estado de la transacción mediante un bucle con un breve tiempo de espera (no recomendamos comprobar el estado con más frecuencia que una vez por segundo), envíe una solicitud GET al recurso transactions/<transaction_id> con el identificador de la transacción en el URI de la solicitud: 
GET https://your-server/api/publicapi/v1/transactions/transaction-id
Para Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"
Para Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'
Como resultado, recibirá una respuesta que contiene el estado de la transacción. El procesamiento de la transacción puede encontrarse 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 6.

​
Descarga de archivos de origen

Para obtener 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: 
GET https://your-server/api/publicapi/v1/transactions/transaction-id/documents
En Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/documents" \
-H "Authorization: Bearer token"
En Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'Authorization: Bearer token'
Como resultado, recibirá una lista de todos los documentos creados dentro de esta transacción. La respuesta también incluye los identificadores de estos documentos, que pueden ser necesarios para solicitar información detallada sobre documentos específicos. Para solicitar la lista de archivos agregados a un documento específico, envíe una solicitud GET al recurso transactions/<transaction-id>/documents/<document-id>: 
GET https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id
Para Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id" \
-H "Authorization: Bearer token"
Para Linux: 
curl -X GET 'https://tu-servidor/api/publicapi/v1/transactions/transaction-id/documents/document-id' \
-H 'Authorization: Bearer token'
Como resultado, recibirá información sobre el documento. La respuesta también incluye los identificadores de los archivos agregados al documento. Para descargar el archivo de origen, envíe una solicitud GET al recurso transactions/<transaction-id>/files/<file-id>/download: 
GET https://tu-servidor/api/publicapi/v1/transactions/transaction-id/files/file-id/download
Para Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"
En Linux: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'