CLI/CMD do verificador VIES

o viesapi-cli.exe O aplicativo cliente permite a verificação rápida e automática de entidades (contratados) a partir da linha de comando (CLI/CMD) em termos de seu status atual no sistema VIES. O aplicativo também permite salvar os dados baixados em um arquivo em 3 formatos:

  • JSON
  • PROP (lista de propriedades em forma de chave = valor)
  • XML

O aplicativo foi testado com sucesso nas seguintes versões do MS Windows: XP, 7, 10 e 11. A versão mais recente do aplicativo está sempre disponível para download no site Download página.

A funcionalidade completa do aplicativo pode ser verificada – sem a necessidade de criar uma conta – usando o API de teste

Para usar o suplemento na API de produção, você precisa configurar uma conta no site viesapi.eu, adquirir um mínimo do plano de negócios e gerar uma chave de API e um identificador de chave de API.

O processo de registro e criação de uma conta, bem como geração de chaves, foi descrito no Documentação local na rede Internet.

Ativação

O programa executável compartilhado viesapi-cli.exe não requer instalação e não precisa ser executado em uma conta com privilégios administrativos. Para executar o programa, selecione o Command Prompt aplicação do Start menu ou tipo cmd no Search programs and files campo e pressione Enter:

Após iniciar o console, vá até o diretório onde está o arquivo zip com viesapi-cli.exe foi baixado e descompactado.

Iniciar o programa sem especificar parâmetros exibe a janela de ajuda.

Configuração

Lançando o viesapi-cli.exe aplicativo sem especificar o API key ID e API key permite consultar o ambiente de teste (mais detalhes sobre o Teste a API VIES página).

Para se conectar ao ambiente de produção, é necessário chamar o viesapi-cli.exe aplicação com os parâmetros de autenticação, que são:

  • keyid – o parâmetro deve conter o identificador de chave de API (ID) gerado na conta no site viesapi.eu,
  • key – o parâmetro deve conter a chave API (Chave) gerada na conta no site viesapi.eu.

Os detalhes sobre como gerar o identificador e a chave estão descritos no Documentação página. Abaixo está um exemplo de chamada do aplicativo com parâmetros de autenticação (keyid e key):

viesapi-cli.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -vies -format xml

Sintaxe de chamada

Sintaxe de chamada do viesapi-cli.exe programa:

viesapi-cli.exe <action> [options]

Ações disponíveis:

-help – descrição dos parâmetros de chamada do programa
-vies – status atual do sistema VIES
-account – situação da conta corrente
-data – obter dados da empresa do VIES
-data-parsed – obter dados da empresa do VIES com dados analisados
-batch-upload – carregar lote de números de IVA e obter token de lote
-batch-download – verificar o resultado do lote e baixar os dados

Opções disponíveis:

-keyid string – Identificador de chave de API
-key string - Chave API
-euvat number – Número de identificação do IVA da UE com prefixo do país
-token string – valor do token de lote
-format type – tipo de formato de saída (json, prop, xml), padrão: json
-file-in path – caminho do arquivo de entrada
-file-out path – caminho do arquivo de saída
-proxy url – Configuração do proxy HTTP (como URL http://user:password@hostname:port)

Exemplos

ATENÇÃO! Os exemplos a seguir são adaptados aos dados coletados no ambiente de teste. Para realizar verificações no ambiente de produção, adicione o –keyid e –key parâmetros com os valores apropriados para cada consulta.

1. Verifica o status atual do sistema VIES e exibe o resultado como XML:

viesapi-cli.exe -vies -format xml

2. Verifica o status atual da conta e salva o resultado em um arquivo JSON:

viesapi-cli.exe -account -file-out result.json.

3. Baixa os dados da empresa do VIES e exibe o resultado como PROP:

viesapi-cli.exe -data -euvat PL5213003700 -format prop

4. Baixa os dados analisados da empresa do VIES e salva o resultado em um arquivo JSON:

viesapi-cli.exe -data-parsed -euvat PL5213003700 -file-out result.json

5. Carrega um arquivo em lote (um número por linha) e recebe um token de lote para verificação de resultados:

viesapi-cli.exe -batch-upload -file-in numbers.csv

6. Verifica o status atual do lote e salva o resultado em um arquivo JSON:

viesapi-cli.exe -batch-download -token 1fd853a5-ac9e-490c-81a1-d4900a9c906c -file-out result.json