Pular para o conteúdo principal

​
Obtendo uma lista de transações

Uma lista de todas as transações ativas ou concluídas pode ser usada para:
  • Acompanhar transações ativas que estão na etapa de revisão manual.
  • Obter um link de revisão manual para transações ativas.
  • Baixar os arquivos de resultados de transações concluídas.
Você pode obter uma lista de transações com seus identificadores usando a Vantage API. Você também pode usar o Skill Monitor para aplicar filtros mais avançados.

​
Lista de transações ativas

Para obter uma lista de transações ativas, envie uma solicitação GET para o recurso transactions/active. No corpo da solicitação, especifique os seguintes parâmetros:
ParameterDescription
StageTypeA etapa da transação.
Os valores possíveis são:
- ManualReview
- CustomActivity
- Automatic (todas as etapas em que não é necessária a intervenção do usuário, por exemplo, extração de campos)
StageNameO nome da ação específica (apenas para a etapa ManualReview).
SkillIdO identificador da Skill.
Se nenhum valor for especificado, todas as Skills disponíveis serão consideradas.
SkillVersionA versão da Skill.
Se nenhum valor for especificado, todas as versões das Skills disponíveis serão consideradas.
StartDateA data e hora de criação da transação mais antiga (deve estar em formato UTC).
EndDateA data e hora de criação da transação mais recente (deve estar em formato UTC).
Se esse valor não for especificado, será usado o horário UTC atual.
TransactionParametersA lista de parâmetros da transação composta por pares chave‑valor de string. Esses parâmetros fornecem informações adicionais do usuário (por exemplo, o nome do cliente).
Os parâmetros devem ser fornecidos no seguinte formato: TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}
DocumentParametersA lista de parâmetros do documento composta por pares chave‑valor de string. Esses parâmetros fornecem informações adicionais do documento (por exemplo, o nome do arquivo).
Os parâmetros devem ser fornecidos no seguinte formato: DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}
OffsetO deslocamento da paginação.
O valor padrão do parâmetro é 0.
LimitO limite de paginação. O parâmetro é obrigatório.
O valor padrão do parâmetro é 0.
Exemplo de solicitação (Windows): 
curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"
Também disponível em outras regiões: 
# América do Norte
curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/active" \
  -H "Authorization: Bearer token"

# Austrália
curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/active" \
  -H "Authorization: Bearer token"
Exemplo de requisição (Linux): 
curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/active' \
  -H 'Authorization: Bearer token'
Também disponível em outras regiões: 
# América do Norte
curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/active' \
  -H 'Authorization: Bearer token'

# Austrália
curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/active' \
  -H 'Authorization: Bearer token'
A resposta a uma solicitação com um identificador de skill especificado conterá um arquivo JSON semelhante ao seguinte: 
{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Revisão",
      "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
}
A resposta a uma solicitação com um estágio e uma ação especificados incluirá um arquivo JSON com todas as transações ativas, semelhante ao seguinte: 
{
  "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
}
Você também pode obter um link do cliente de revisão manual para transações ativas no momento. Para isso, envie uma solicitação GET ao recurso transactions/<transaction_id> com o identificador da transação no URI da solicitação. Exemplo de solicitação (Windows): 
curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"
Também disponível em outras regiões: 
# América do Norte
curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"

# Austrália
curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"
Exemplo de requisição (Linux): 
curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
  -H 'Authorization: Bearer token'
Também disponível em outras regiões: 
# América do Norte
curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
  -H 'Authorization: Bearer token'

# Austrália
curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
  -H 'Authorization: Bearer token'
A resposta conterá um código semelhante ao abaixo: 
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Processando",
  "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": "Processando",
  "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": "Processando",
  "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"
    }
  ]
}
A chave manualReviewLink conterá um link para a interface web do cliente de revisão manual e um token de acesso do Vantage, se a revisão manual for necessária. Esse link e token podem ser usados para revisar e corrigir os resultados de classificação e extração de campos de uma transação específica. O link fornecido é válido por 168 horas; após esse período, deve-se criar e obter um novo link para outro período de 168 horas usando o mesmo método. Para mais informações, consulte Integração da revisão manual.
Usuários autorizados por meio deste link não poderão visualizar ou modificar quaisquer outros documentos ou transações.

​
Lista de transações concluídas

Para obter uma lista de transações concluídas, envie uma solicitação GET para o recurso transactions/completed. No corpo da solicitação, especifique os parâmetros:
ParameterDescription
TransactionStatusO status da transação.
Os valores possíveis são:
- Processed
- Canceled
- Failed
SkillIdO identificador da Skill.
Se nenhum valor for especificado, todas as Skills disponíveis serão consideradas.
SkillVersionA versão da Skill.
Se nenhum valor for especificado, todas as versões das Skills disponíveis serão consideradas.
StartDateA data e hora de criação da transação mais antiga (deve estar em formato UTC).
EndDateA data e hora de criação da transação mais recente (deve estar em formato UTC).
Se esse valor não for especificado, será usado o horário UTC atual.
TransactionParametersA lista de parâmetros da transação composta por pares chave-valor do tipo string. Esses parâmetros fornecem informações adicionais do usuário (por exemplo, o nome do cliente).
Os parâmetros devem ser fornecidos no seguinte formato: TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}
DocumentParametersA lista de parâmetros do documento composta por pares chave-valor do tipo string. Esses parâmetros fornecem informações adicionais do documento (por exemplo, o nome do arquivo).
Os parâmetros devem ser fornecidos no seguinte formato: DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}
OffsetO deslocamento da paginação.
O valor padrão do parâmetro é 0.
LimitO limite de paginação. O parâmetro é obrigatório.
O valor padrão do parâmetro é 0.
A resposta conterá um JSON com todas as transações concluídas e o número de Páginas processadas, semelhante ao seguinte: 
{
  "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
}