Saltar al contenido principal

​
Obtener una lista de transacciones

Una lista de todas las transacciones activas o completadas se puede usar para:
  • Hacer 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 transacciones completadas.
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:
ParámeterDescripción
StageTypeLa etapa de la transacción.
Los valores posibles son:
- ManuaReview
- CustomActivity
- Automatic (todas las etapas en las que no se requiere la intervención del usuario, por ejemplo, extracción de campos)
StageNameEl nombre de la acción específica (solo para la etapa ManualReview).
SkillIdEl identificador de la Habilidad.
Si no se especifica ningún valor, se tendrán en cuenta todas las Habilidades disponibles.
SkillVersionLa versión de la Habilidad.
Si no se especifica ningún valor, se tendrán en cuenta todas las versiones de las Habilidades disponibles.
StartDateLa hora de creación de la transacción más antigua (debe especificarse en formato UTC).
EndDateLa 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.
TransactionParametersLa lista de parámetros de la transacción compuesta por pares clave-valor de 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”}
DocumentParametersLa lista de parámetros del documento compuesta por pares clave-valor de 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”}
OffsetEl desplazamiento de paginación.
El valor predeterminado del parámetro es 0.
LimitEl límite de paginación. El parámetro es obligatorio.
El valor predeterminado del parámetro es 0.
Solicitud de ejemplo (Windows): 
curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"
También disponible en otras regiones: 
# América del Norte
curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/active" \
  -H "Authorization: Bearer token"

# Australia
curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/active" \
  -H "Authorization: Bearer token"
Ejemplo de solicitud (Linux): 
curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/active' \
  -H 'Authorization: Bearer token'
También disponible en otras regiones: 
# América del Norte
curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/active' \
  -H 'Authorization: Bearer token'

# Australia
curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/active' \
  -H 'Authorization: Bearer token'
La respuesta a una solicitud con un identificador de skill específico contendrá un archivo JSON similar al siguiente: 
{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Revisión",
      "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 con una etapa y una acción especificadas incluirá 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 (Windows): 
curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"
También disponible en otras regiones: 
# América del Norte
curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"

# Australia
curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"
Ejemplo de solicitud (Linux): 
curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
  -H 'Authorization: Bearer token'
También disponible en otras regiones: 
# América del Norte
curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
  -H 'Authorization: Bearer token'

# Australia
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": "Procesando",
  "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": "Procesando",
  "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": "Procesando",
  "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 la revisión manual. Este enlace y token pueden utilizarse para revisar y corregir la clasificación y los resultados de extracción de campos de una transacción en particular. El enlace proporcionado es válido durante 168 horas, tras lo cual debe crearse y obtenerse un nuevo enlace para otro período de 168 horas mediante el mismo método. Para obtener más información, consulte Integrating manual review.
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:
ParameterDescription
TransactionStatusEl estado de la transacción.
Los valores posibles son:
- Processed
- Canceled
- Failed
SkillIdEl identificador de la Habilidad.
Si no se especifica ningún valor, se tendrán en cuenta todas las Habilidades disponibles.
SkillVersionLa versión de la Habilidad.
Si no se especifica ningún valor, se tendrán en cuenta todas las versiones de las Habilidades disponibles.
StartDateLa hora de creación de la transacción más antigua (debe especificarse en formato UTC).
EndDateLa 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.
TransactionParametersLa lista de parámetros de la 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”}
DocumentParametersLa lista de parámetros del 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”}
OffsetEl desplazamiento de paginación.
El valor predeterminado del parámetro es 0.
LimitEl límite de paginación. El parámetro es obligatorio.
El valor predeterminado del parámetro es 0.
La respuesta contendrá un archivo JSON con todas las transacciones completadas y una cantidad de Páginas procesadas similar a la siguiente: 
{
  "items": [
    {
      "status": "FinishedSuccessfully",
      "pageCount": 1,
      "seqId": 13705,
      "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"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 29842,
      "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"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36254,
      "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"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36632,
      "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"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36663,
      "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"
        }
      ],
      "documentCount": 1
    }
  ],
  "totalItemCount": 5
}