The viesapi-cli.exe Klientska aplikácia umožňuje rýchlu a automatickú kontrolu subjektov (zhotoviteľov) z úrovne príkazového riadku (CLI / CMD) z hľadiska ich aktuálneho stavu v systéme VIES. Aplikácia tiež umožňuje ukladať stiahnuté dáta do súboru v 3 formátoch:
- JSON
- PROP (zoznam vlastností vo forme kľúč = hodnota)
- XML
Aplikácia bola úspešne testovaná v nasledujúcich verziách MS Windows: XP, 7, 10 a 11. Najnovšia verzia aplikácie je vždy k dispozícii na stiahnutie z 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 v 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 volania viesapi-cli.exe program:
viesapi-cli.exe <action>
Dostupné akcie:
-help – popis parametrov volania programu
-vies – aktuálny stav systému VIES
-account – stav bežného účtu
-data – získať firemné údaje z VIES
-data-parsed – získať firemné údaje z VIES s analyzovanými údajmi
-batch-upload – nahrať dávku IČ DPH a získať token dávky
-batch-download – skontrolovať výsledok dávky a stiahnuť údaje
Dostupné možnosti:
-keyid string – Identifikátor kľúča API
-key string - API kľúč
-euvat number – IČ DPH EÚ s predvoľbou krajiny
-token string – hodnota dávkového tokenu
-format type – typ výstupného formátu (json, prop, xml), predvolený: json
-file-in path – cesta k vstupnému súboru
-file-out path – cesta k výstupnému súboru
-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. Skontroluje aktuálny stav systému VIES a zobrazí výsledok ako XML:
viesapi-cli.exe -vies -format xml
2. Skontroluje aktuálny stav účtu a uloží výsledok do súboru JSON:
viesapi-cli.exe -account -file-out result.json.
3. Stiahne firemné údaje z VIES a zobrazí výsledok ako PROP:
viesapi-cli.exe -data -euvat PL5213003700 -format prop
4. Stiahne analyzované dáta spoločnosti z VIES a uloží výsledok do súboru JSON:
viesapi-cli.exe -data-parsed -euvat PL5213003700 -file-out result.json
5. Nahrá dávkový súbor (jedno číslo na riadok) a prijme dávkový token na kontrolu výsledku:
viesapi-cli.exe -batch-upload -file-in numbers.csv
6. Skontroluje aktuálny stav dávky a uloží výsledok do súboru JSON:
viesapi-cli.exe -batch-download -token 1fd853a5-ac9e-490c-81a1-d4900a9c906c -file-out result.json