Saltar al contenido principal
Un escenario típico para procesar documentos con una única llamada a la API (crear una transacción, cargar un archivo e iniciar una transacción) consta de los siguientes pasos:
  1. Recibir la lista de todas las skills disponibles
  2. Crear e iniciar la transacción
  3. Supervisar el estado de la transacción
  4. Descargar los archivos de origen y los archivos de resultados
Cada solicitud al servidor debe incluir información de autenticación. Para obtener más información, consulte Authentication. Use este escenario si solo tiene un archivo de menos de 30 MB y no necesita editar las imágenes del archivo.

​
Obtener una lista de todas las skills disponibles

Para ello, envíe una solicitud GET al recurso skills: 
GET https://your-server/api/publicapi/v1/skills
Ejecute el siguiente comando: Para Windows: 
curl -X GET "https://tu-servidor/api/publicapi/v1/skills" \
-H "Authorization: Bearer token"
En Linux: 
curl -X GET 'https://tu-servidor/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 e inicio de una transacción

Para ello, envíe una solicitud POST al recurso transactions/launch: 
POST https://your-server/api/publicapi/v1/transactions/launch
En el cuerpo de la solicitud, especifique el parámetro skillId, que se devolvió en la llamada a la API anterior, y envíe el archivo para procesarlo. Un ejemplo de cuerpo de la solicitud podría ser el siguiente: 
{
  "settings": {
    "skillId": "00000000-0000-0000-0000-000000000001"
  },
  "files": [
    {
      "file": "image content"
    }
  ]
}
Ejecute el siguiente comando: En Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/launch" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"settings\": {
     \"skillId\": \"00000000-0000-0000-0000-000000000001\"
   },
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
Para Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/launch' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "settings": {
     "skillId": "00000000-0000-0000-0000-000000000001"
   },
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'
Como resultado, recibirás una respuesta que incluye el id de la transacción creada.

​
Supervisar el estado de la transacción

Para ello, envíe una solicitud GET al recurso transactions: 
GET https://su-servidor/api/publicapi/v1/transactions/transaction-id
Ejecute el siguiente comando: En Windows: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"
En 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 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.

​
Descarga de archivos de origen y de resultados

Para descargar el archivo de origen, envíe una solicitud GET al recurso transactions/files/download, donde debe especificar el ID del archivo recibido en la solicitud anterior: 
GET https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download
Ejecute el siguiente comando: 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://tu-servidor/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'