Pular para o conteúdo principal
Os parâmetros de registro de transação e arquivo são parâmetros compostos por pares de chave-valor do tipo string, projetados para fornecer informações adicionais do usuário (por exemplo, nome do cliente, tipo de documento e informações sobre a origem do arquivo). Eles são enviados para processamento junto com a transação ou os documentos da transação. Esses parâmetros ficam disponíveis para todos os workers e podem ser utilizados em diversos cenários de produção:
  • Um programa que usa ABBYY Vantage identifica cada transação com um atributo de cliente final, para fins de geração de relatórios e criação de procedimentos de processamento personalizados (por exemplo, filtrando catálogos de dados de contrapartes por cliente).
  • Um cliente do Scanning Station (ou outra origem de transações) pode fornecer os parâmetros de registro de um lote de documentos (tais como um ID de correlação externo).
Os parâmetros de registro podem ser definidos usando a Vantage API:
  1. Ao criar uma transação vazia ou ao inicializar uma transação usando o método launch, envie uma requisição POST para o recurso transactions, como no exemplo abaixo:
POST https://your-server/api/publicapi/v1/transactions
ou 
POST https://your-server/api/publicapi/v1/transactions/launch?skillId=skill-id
No corpo da solicitação, especifique os parâmetros de registro e execute o seguinte comando: Para Windows: 
curl -X POST "https://your-server/api/publicapi/v1/transactions" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json" \
-d "{\"skillId\":\"123\"}" \
   "registrationParameters": [
     {
       "key": "key1",
       "value": "value1"
     }
   ]
Para Linux: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{"skillId":"123"}' \
   'registrationParameters': [
     {
       'key': 'key1',
       'value': 'value1'
     }
   ]
  1. Ao enviar arquivos para uma transação ou um documento, envie uma requisição POST para o recurso transactions/<transaction-id>/files, como no exemplo abaixo:
POST https://your-server/api/publicapi/v1/transactions/transaction-id/files
No corpo da solicitação, especifique os parâmetros de registro e execute o seguinte 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\": [
     {
       \"index\": 0,
       \"imageProcessingOptions\": {
         \"autoCrop\": \"Default\",
         \"autoOrientation\": \"Default\"
       },
       \"registrationParameters\": [
         {
           \"key\": \"key1\",
           \"value\": \"value1\"
         }
       ]
     }
   ]
}" \
-F "[email protected];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": [
     {
       "index": 0,
       "imageProcessingOptions": {
         "autoCrop": "Default",
         "autoOrientation": "Default"
       },
       "registrationParameters": [
         {
           "key": "key1",
           "value": "value1"
         }
       ]
     }
   ]
}' \
-F '[email protected];type=image/tiff'
Importante! Pode haver no máximo 10 Parameters do tipo chave-valor, em que o Parameter de chave pode conter até 128 caracteres e o Parameter de valor pode conter até 256 caracteres. Os valores desses Parameters não podem ser alterados após serem definidos.
Os valores dos Parameters de registro podem ser lidos:
  • em scripts de atividades personalizadas,
  • em scripts de exportação externa na atividade Output,
  • nas regras de negócio.
Você pode obter valores de parâmetros de registro usando a API Vantage da seguinte maneira:
  1. Ao chamar o método registrationParameters para o recurso transactions/<transaction-id>/registrationParameters:
GET https://your-server/api/publicapi/v1/transactions/transaction-id/registrationParameters/
A resposta será semelhante ao seguinte: 
[
  {
    "key": "key1",
    "value": "value1"
  }
]
  1. Ao usar uma chamada ao método download para o recurso transactions/<transaction-id>/files/<file-id>/download para obter os valores no formato JSON juntamente com o arquivo sendo enviado:
GET https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download