The 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 ladata sivu.
Sovelluksen koko toiminnallisuus voidaan tarkistaa – ilman tarvetta luoda tiliä – käyttämällä mukana toimitettua Testaa API
Jotta voit käyttää apuohjelmaa tuotantosovellusliittymässä, sinun on luotava tili viesapi.eu-verkkosivustolle, ostettava vähintään liiketoimintasuunnitelma ja luotava API-avain ja API-avaimen tunniste.
Tilin rekisteröinti- ja perustamisprosessi sekä avainten luonti on kuvattu sivulla Dokumentointi verkkosivusto.
Aktivointi
Jaettu suoritettava ohjelma viesapi-cli.exe ei vaadi asennusta, eikä sitä tarvitse suorittaa järjestelmänvalvojan oikeuksilla varustetulla tilillä. Suorita ohjelma valitsemalla Command Prompt sovellus osoitteesta Start valikko tai tyyppi cmd in the Search programs and files -kenttään ja paina Enter:
Kun olet käynnistänyt konsolin, siirry hakemistoon, jossa zip-tiedosto on viesapi-cli.exe ladattiin ja purettiin.
Ohjelman käynnistäminen ilman parametrien määrittämistä avaa ohjeikkunan.
Kokoonpano
Käynnistetään viesapi-cli.exe sovellus määrittelemättä API key ID ja API key voit tehdä kyselyjä testiympäristöstä (lisätietoja Testaa VIES API sivu).
Yhteyden muodostamiseksi tuotantoympäristöön on tarpeen kutsua esiin viesapi-cli.exe sovellus todennusparametreilla, jotka ovat:
keyid– parametrin tulee sisältää viesapi.eu-sivustolla olevalle tilille luotu API-avaimen tunniste (ID),key– parametrin tulee sisältää viesapi.eu-sivustolla olevalle tilille luotu API-avain (Key).
Yksityiskohdat tunnisteen ja avaimen luomisesta on kuvattu Dokumentointi sivu. Alla on esimerkki sovelluksen kutsumisesta todennusparametreilla (keyid ja key):
viesapi-cli.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -vies -format xml
Kutsusyntaksi
Syntax of calling the viesapi-cli.exe program:
viesapi-cli.exe <action>
Available actions:
-help – ohjelman kutsuparametrien kuvaus
-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-avaimen tunniste
-key string – API-avain
-euvat number – EU:n ALV-tunnus ja maan etuliite
-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-välityspalvelimen määritys (URL-osoitteena http://user:password@hostname:port)
Esimerkkejä
HUOMIO! Seuraavat esimerkit on mukautettu testiympäristössä kerättyihin tietoihin. Voit suorittaa tuotantoympäristön tarkistuksia lisäämällä –keyid ja –key parametrit sopivilla arvoilla jokaiselle kyselylle.
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