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 Stiahnuť ▼ stránku.
Plnú funkčnosť aplikácie je možné skontrolovať – bez potreby vytvorenia účtu – pomocou poskytnutého Test API
Ak chcete použiť doplnok v produkčnom API, musíte si zriadiť účet na stránke viesapi.eu, zakúpiť si minimálne Business plán a vygenerovať API kľúč a identifikátor API kľúča.
Proces registrácie a nastavenia účtu, ako aj generovanie kľúčov je popísaný na stránke Dokumentácia webovej stránky.
Aktivácia
Zdieľaný spustiteľný program viesapi-cli.exe nevyžaduje inštaláciu a nemusí sa spúšťať pod účtom s oprávneniami správcu. Ak chcete spustiť program, vyberte Command Prompt žiadosť z Start menu alebo typu cmd in the Search programs and files pole a stlačte Enter:
Po spustení konzoly prejdite do adresára, kde sa nachádza súbor zip viesapi-cli.exe bol stiahnutý a rozbalený.
Po spustení programu bez zadania parametrov sa zobrazí okno pomocníka.
Konfigurácia
Spustenie viesapi-cli.exe aplikáciu bez uvedenia API key ID a API key vám umožňuje dotazovať sa na testovacie prostredie (viac podrobností o Otestujte VIES API stránka).
Pre pripojenie k produkčnému prostrediu je potrebné vyvolať viesapi-cli.exe aplikácia s parametrami autentifikácie, ktorými sú:
keyid– parameter by mal obsahovať identifikátor API kľúča (ID) vygenerovaný na účte na stránke viesapi.eu,key– parameter by mal obsahovať API kľúč (Kľúč) vygenerovaný na účte na stránke viesapi.eu.
Podrobnosti o generovaní identifikátora a kľúča sú popísané na Dokumentácia stránku. Nižšie je uvedený príklad volania aplikácie s parametrami autentifikácie (keyid a key):
viesapi-cli.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -vies -format xml
Syntax volania
Syntax of calling the viesapi-cli.exe program:
viesapi-cli.exe <action>
Available actions:
-help – popis parametrov volania programu
-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 – Identifikátor kľúča API
-key string - API kľúč
-euvat number – IČ DPH EÚ s predvoľbou krajiny
-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 – konfigurácia HTTP proxy (ako URL http://user:password@hostname:port)
Príklady
POZOR! Nasledujúce príklady sú prispôsobené údajom zozbieraným v testovacom prostredí. Ak chcete vykonať kontroly produkčného prostredia, pridajte –keyid a –key parametre s príslušnými hodnotami pre každý dotaz.
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