Pular para o conteúdo principal
A Vantage API permite acessar parâmetros de Skill de Documento e de Skill de Processo e alterar seus valores para uma transação específica. Os parâmetros de Skill passados em uma transação consistem em pares chave-valor do tipo string. Para parâmetros de Skill de Documento e de Skill de Processo, os valores definidos via a Vantage API terão prioridade sobre aqueles definidos via a Vantage UI.

​
Alterando valores de Parameter de Skill

Para alterar valores de Parameter de Skill via a Vantage API, faça o seguinte:

​
Etapa 1: Criar ou inicializar uma Transação

Crie uma transação vazia ou inicialize uma transação usando o método launch. Para isso, envie uma requisição POST para o recurso transactions: 
POST {your-host}/api/publicapi/v1/transactions
ou 
POST {your-host}/api/publicapi/v1/transactions/launch?skillId={skill-id}
No corpo da solicitação, especifique novos valores para os parâmetros da skill e execute o comando a seguir:

​
Exemplo no Windows

curl -X POST "{your-host}/api/publicapi/v1/transactions" ^
-H "Authorization: Bearer {token}" ^
-H "Content-Type: application/json" ^
-d "{\"skillId\":\"123\",\"skillParameters\":[{\"key\":\"Novo parâmetro\",\"value\":\"Vendors novo\"}]}"

​
Exemplo em Linux

curl -X POST '{your-host}/api/publicapi/v1/transactions' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{"skillId":"123","skillParameters":[{"key":"New parameter","value":"Vendors new"}]}'
Observação: Pode haver no máximo 10 parâmetros de skill no formato chave–valor, em que cada chave pode ter até 128 caracteres e cada valor, até 256 caracteres.

​
Obtendo valores de Parameter de Skill

Para obter valores de Parameter de skill usando a Vantage API, faça o seguinte:

​
Opção 1: Obter Parameters da Skill diretamente

Envie uma solicitação GET para o recurso transactions/{transaction-id}/skillParameters: 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/skillParameters/
A resposta terá o seguinte formato: 
[
  {
    "key": "Novo Parameter",
    "value": "Vendors"
  }
]

​
Opção 2: Baixar arquivos da Transação

Envie uma solicitação GET ao recurso transactions/{transaction-id}/files/{file-id}/download para obter os valores em formato JSON: 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/files/{file-id}/download