Obtener una lista de transacciones

Una lista de todas las transacciones activas o completadas se puede utilizar para:

Hacer un seguimiento de las transacciones activas que se encuentran actualmente en la etapa de revisión manual.
Obtener un enlace de revisión manual para transacciones activas.
Descargar los archivos de resultados de las transacciones completadas.
Recoger las transacciones finalizadas en el orden en que se completaron, sin necesidad de llevar un registro de cuáles ya ha recogido.

Puede obtener una lista de transacciones con sus identificadores mediante la Vantage API. Puede usar Skill Monitor para aplicar filtros más avanzados.

Lista de transacciones activas

Para obtener una lista de transacciones activas, envíe una solicitud GET al recurso transactions/active. En el cuerpo de la solicitud, especifique los siguientes parámetros:

Parameter	Description
StageType	La etapa de la transacción. Los valores posibles son: - ManuaReview - CustomActivity - Automatic (todas las etapas en las que no se requiere intervención del usuario, por ejemplo, la extracción de campos)
StageName	El nombre de la acción específica (solo para la etapa ManualReview).
SkillId	El identificador de la skill. Si no se especifica un valor, se tendrán en cuenta todas las skills disponibles.
SkillVersion	La versión de la skill. Si no se especifica un valor, se tendrán en cuenta todas las versiones de las skills disponibles.
StartDate	La hora de creación de la transacción más antigua (debe especificarse en formato UTC).
EndDate	La hora de creación de la transacción más reciente (debe especificarse en formato UTC). Si no se especifica este valor, se utilizará la hora UTC actual.
TransactionParameters	La lista de parámetros de transacción compuesta por pares clave-valor de tipo cadena. Estos parámetros proporcionan información adicional sobre el usuario (por ejemplo, el nombre del cliente). Los parámetros deben proporcionarse en el siguiente formato: `TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}`
DocumentParameters	La lista de parámetros de documento compuesta por pares clave-valor de tipo cadena. Estos parámetros proporcionan información adicional sobre el documento (por ejemplo, el nombre del archivo). Los parámetros deben proporcionarse en el siguiente formato: `DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}`
Offset	El desplazamiento de paginación. El valor predeterminado del parámetro es 0.
Limit	El límite de paginación. El parámetro es obligatorio. Valores aceptados: 1 a 1000.

Ejemplo de solicitud:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"

La respuesta a una solicitud que incluya un identificador de skill contendrá un archivo JSON similar al siguiente:

{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Review",
      "seqId": 13758,
      "transactionId": "56a50415-fe1d-4493-81ba-97ff07e3ffce",
      "createTimeUtc": "2023-09-11T13:53:30.633Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "skillId": "workspace.default.processing",
      "skillVersion": 18,
      "documentCount": 1
    }
  ],
  "totalItemCount": 7
}

La respuesta a una solicitud en la que se especifiquen una etapa y una acción contendrá un archivo JSON con todas las transacciones activas, similar al siguiente:

{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Review2",
      "seqId": 13852,
      "transactionId": "e646754e-d854-4b21-af91-58cb63ead7a6",
      "createTimeUtc": "2023-09-11T14:04:37.97Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "documentCount": 1
    }
  ],
  "totalItemCount": 2
}

También puede obtener un enlace del cliente de revisión manual para transacciones activas. Para hacerlo, envíe una solicitud GET al recurso transactions/<transaction_id> con el identificador de la transacción en el URI de la solicitud. Solicitud de ejemplo:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"

La respuesta incluirá un código similar al siguiente:

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Processing",
  "manualReviewLink": "https://vantage-us.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
  "sourceFiles": [
    {
      "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
      "name": "Invoice07.JPG"
    }
  ]
}

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Processing",
  "manualReviewLink": "https://vantage-eu.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
  "sourceFiles": [
    {
      "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
      "name": "Invoice07.JPG"
    }
  ]
}

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Processing",
  "manualReviewLink": "https://vantage-au.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
  "sourceFiles": [
    {
      "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
      "name": "Invoice07.JPG"
    }
  ]
}

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 token se pueden usar para revisar y corregir los resultados de clasificación y extracción de campos de una transacción en particular. El enlace proporcionado es válido durante 168 horas, tras lo cual se debe crear y obtener un nuevo enlace para otro período de 168 horas utilizando el mismo método. Para obtener más información, consulte Integración de la revisión manual.

Los usuarios autorizados mediante este enlace no podrán ver ni modificar ningún otro documento ni transacción.

Lista de transacciones completadas

Para obtener una lista de transacciones completadas, envíe una solicitud GET al recurso transactions/completed. En el cuerpo de la solicitud, especifique los parámetros:

Parameter	Description
TransactionStatus	El estado de la transacción. Los valores posibles son: - Processed - Cancelled - Failed
SkillId	El identificador de la skill. Si no se especifica ningún valor, se considerarán todas las skills disponibles.
SkillVersion	La versión de la skill. Si no se especifica ningún valor, se considerarán todas las versiones de las skills disponibles.
StartDate	La hora de creación de la transacción más antigua (debe especificarse en formato UTC).
EndDate	La hora de creación de la transacción más reciente (debe especificarse en formato UTC). Si no se especifica este valor, se utilizará la hora UTC actual.
TransactionParameters	La lista de parámetros de transacción compuesta por pares clave-valor de tipo cadena. Estos parámetros proporcionan información adicional del usuario (por ejemplo, el nombre del cliente). Los parámetros deben proporcionarse en el siguiente formato: `TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}`
DocumentParameters	La lista de parámetros de documento compuesta por pares clave-valor de tipo cadena. Estos parámetros proporcionan información adicional del documento (por ejemplo, el nombre del archivo). Los parámetros deben proporcionarse en el siguiente formato: `DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}`
Offset	El desplazamiento de paginación. El valor predeterminado del parámetro es 0.
Limit	El límite de paginación. El parámetro es obligatorio. Valores aceptados: de 1 a 1000.

La respuesta contendrá un archivo JSON con todas las transacciones completadas y el número de páginas procesadas similar al siguiente:

{
  "items": [
    {
      "status": "Processed",
      "pageCount": 1,
      "transactionId": "fc9920fe-f788-47f8-9972-b767493faed9",
      "createTimeUtc": "2023-09-11T13:47:50.273Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 1,
      "documentCount": 1
    },
    {
      "status": "Processed",
      "pageCount": 2,
      "transactionId": "c0dd3e08-f295-4c6c-b919-31eaa67817cc",
      "createTimeUtc": "2023-09-12T19:28:01.27Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed _1_.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 2,
      "documentCount": 1
    },
    {
      "status": "Processed",
      "pageCount": 2,
      "transactionId": "8391871e-abf5-41bc-8a66-1059418a3843",
      "createTimeUtc": "2023-09-13T08:53:41.9Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed _1_.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 2,
      "documentCount": 1
    },
    {
      "status": "Processed",
      "pageCount": 2,
      "transactionId": "7f7cd557-a03e-42e3-a454-e7981e8e9fc0",
      "createTimeUtc": "2023-09-13T09:35:27.48Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 2,
      "documentCount": 1
    },
    {
      "status": "Processed",
      "pageCount": 2,
      "transactionId": "c9b3cd4d-d90f-48be-adc2-99985ece4e11",
      "createTimeUtc": "2023-09-13T09:38:29.573Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 2,
      "documentCount": 1
    }
  ],
  "totalItemCount": 5
}

Recogida de transacciones finalizadas

El recurso transactions/completed devuelve todas las transacciones completadas dentro de un intervalo de fechas, por lo que una integración que recopile resultados debe llevar su propio registro de las transacciones que ya ha procesado. El recurso transactions/pending-pickup evita esa gestión manual: devuelve las transacciones finalizadas que aún no ha eliminado, en el orden en que finalizaron, y cada transacción desaparece de la lista en cuanto se elimina. Un ciclo de recogida típico es el siguiente:

Envíe una solicitud GET a transactions/pending-pickup.
Para cada transacción devuelta, descargue los archivos de resultados. Consulte Descarga de source files y archivos de resultados.
Elimine la transacción mediante una solicitud DELETE a transactions/<transaction_id>. De este modo se quita de la lista de recogida.
Si la respuesta contiene un nextCursor, repita desde el paso 1 con ese cursor para obtener la página siguiente. Cuando nextCursor esté vacío, habrá llegado al final de la lista. Espere el intervalo de sondeo establecido y vuelva a empezar sin cursor.

En la solicitud, especifique los siguientes parámetros:

Parámetro	Descripción
Limit	El número máximo de transacciones que se devuelven en una página. Valores admitidos: de 1 a 1000.
Cursor	El valor `nextCursor` de la respuesta anterior. Omítalo para comenzar por la transacción finalizada más antigua que no se haya eliminado. Trate el cursor como una cadena opaca.
Status	El estado de la transacción. Los valores posibles son: - Processed - Cancelled - Failed Si no se especifica ningún valor, se devuelven las transacciones con todos estos estados. Para filtrar por más de un estado, separe los valores con comas.
SkillId	El identificador del skill. Si no se especifica ningún valor, se tienen en cuenta todos los skills disponibles y se devuelven las transacciones de todas las versiones del skill.

Solicitud de ejemplo:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Status=Processed" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Status=Processed" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Status=Processed" \
  -H "Authorization: Bearer token"

La respuesta contiene las transacciones finalizadas y un cursor para la página siguiente:

{
  "items": [
    {
      "transactionId": "fc9920fe-f788-47f8-9972-b767493faed9",
      "status": "Processed",
      "finishedTimeUtc": "2026-06-10T12:34:56Z"
    },
    {
      "transactionId": "c0dd3e08-f295-4c6c-b919-31eaa67817cc",
      "status": "Failed",
      "finishedTimeUtc": "2026-06-10T12:35:02Z"
    }
  ],
  "nextCursor": "Q3Vyc29yRXhhbXBsZQ=="
}

Para obtener la página siguiente, vuelva a pasar el cursor en la solicitud:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Cursor=Q3Vyc29yRXhhbXBsZQ==" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Cursor=Q3Vyc29yRXhhbXBsZQ==" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Cursor=Q3Vyc29yRXhhbXBsZQ==" \
  -H "Authorization: Bearer token"

Tenga en cuenta lo siguiente al crear una integración de recogida:

La entrega es “al menos una vez”. Cada transacción finalizada aparece al menos una vez, pero en determinadas circunstancias, como los pocos minutos que transcurren entre una solicitud DELETE y la eliminación efectiva, el mismo transactionId puede aparecer más de una vez. Almacene los identificadores que ya haya procesado y omita los que vuelvan a aparecer.
Recoja los resultados antes de que expiren. Una transacción permanece en la lista de recogida solo mientras sus datos se conservan en Vantage. Si la política de retención de datos elimina la transacción antes de que usted la recoja, esta deja de aparecer en la lista. Los registros históricos siguen disponibles en la Reporting API.
Permisos. La solicitud devuelve únicamente las transacciones de los skills a los que el usuario autenticado tiene permiso de acceso, igual que en transactions/completed.
Intervalo de sondeo. La lista de recogida funciona solo mediante extracción (pull). Sondéela con una periodicidad acorde a la rapidez con la que necesita los resultados, en lugar de hacerlo de forma continua. Para obtener orientación general, consulte Sondeo.

Overview

Developer Guide

Obtener una lista de transacciones

Lista de transacciones activas

Lista de transacciones completadas

Recogida de transacciones finalizadas

​Lista de transacciones activas

​Lista de transacciones completadas

​Recogida de transacciones finalizadas

Lista de transacciones activas

Lista de transacciones completadas

Recogida de transacciones finalizadas