De viesapi-cli.exe client application allows for quick and automatic checking of entities (contractors) from the command line level (CLI / CMD) in terms of their current status in the VIES system. The application also allows you to save the downloaded data to a file in 3 formats:
- JSON
- PROP (list of properties in form of key = value)
- xml
Application has been successfully tested in the following versions of MS Windows: XP, 7, 10 and 11. The latest version of the application is always available for download from the Downloaden bladzijde.
De volledige functionaliteit van de applicatie kan worden gecontroleerd - zonder de noodzaak om een account aan te maken - met behulp van de meegeleverde Test-API
Om de add-in in de productie-API te gebruiken, moet u een account aanmaken op de website viesapi.eu, minimaal het Business-abonnement kopen en een API-sleutel en API-sleutel-ID genereren.
Het proces van het registreren en opzetten van een account en het genereren van sleutels is beschreven op de Documentatie website.
activering
Het gedeelde uitvoerbare programma viesapi-cli.exe vereist geen installatie en hoeft niet te worden uitgevoerd onder een account met beheerdersrechten. Om het programma uit te voeren, selecteert u de Command Prompt aanvraag van de Start menu of type cmd in the Search programs and files veld en druk op Enter:
Ga na het opstarten van de console naar de map waar het zip-bestand zich bevindt viesapi-cli.exe is gedownload en uitgepakt.
Als u het programma start zonder parameters op te geven, wordt het helpvenster weergegeven.
Configuratie
Het lanceren van de viesapi-cli.exe toepassing zonder de API key ID en API key stelt u in staat om de testomgeving te bevragen (meer details op de VIES-API testen bladzijde).
Om verbinding te maken met de productieomgeving is het noodzakelijk om de viesapi-cli.exe toepassing met de authenticatieparameters, die zijn:
keyid– de parameter moet de API key identifier (ID) bevatten die is gegenereerd op het account op de website viesapi.eu,key– de parameter moet de API-sleutel (sleutel) bevatten die is gegenereerd op het account op de website viesapi.eu.
Details over het genereren van de identifier en sleutel worden beschreven op de Documentatie bladzijde. Hieronder ziet u een voorbeeld van het aanroepen van de applicatie met authenticatieparameters (keyid en key):
viesapi-cli.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -vies -format xml
Aanroepende syntaxis
Syntax of calling the viesapi-cli.exe program:
viesapi-cli.exe <action>
Available actions:
-help - beschrijving van parameters voor het oproepen van programma's
-vies – current VIES system status
-account – current account status
-data – get company data from VIES
-data-parsed – get company data from VIES with parsed data
-batch-upload – upload batch of VAT numbers and get batch token
-batch-download – check batch result and download data
Available options:
-keyid string – API-sleutel-ID
-key string - API sleutel
-euvat number – EU-btw-nummer met landvoorvoegsel
-token string – batch token value
-format type – output format type (json, prop, xml), default: json
-file-in path – input file path
-file-out path – output file path
-proxy url – HTTP-proxyconfiguratie (als URL http://user:password@hostname:port)
Voorbeelden
AANDACHT! De volgende voorbeelden zijn aangepast aan de gegevens die in de testomgeving worden verzameld. Om controles uit te voeren op de productieomgeving, voegt u het –keyid en –key parameters met de juiste waarden voor elke query.
1. Checks the current VIES system status and displays the result as XML:
viesapi-cli.exe -vies -format xml
2. Checks the current account status and saves the result to a JSON file:
viesapi-cli.exe -account -file-out result.json.
3. Downloads company data from VIES and displays the result as PROP:
viesapi-cli.exe -data -euvat PL5213003700 -format prop
4. Downloads company parsed data from VIES and saves the result to a JSON file:
viesapi-cli.exe -data-parsed -euvat PL5213003700 -file-out result.json
5. Uploads a batch file (one number per line) and receives a batch token for result checking:
viesapi-cli.exe -batch-upload -file-in numbers.csv
6. Checks the current batch status and saves the result to a JSON file:
viesapi-cli.exe -batch-download -token 1fd853a5-ac9e-490c-81a1-d4900a9c906c -file-out result.json