The viesapi-cli.exe
Klientská aplikace umožňuje rychlou a automatickou kontrolu entit (dodavatelů) z úrovně příkazového řádku (CLI / CMD) z hlediska jejich aktuálního stavu v systému VIES. Aplikace také umožňuje ukládat stažená data do souboru ve 3 formátech:
- JSON
- PROP (seznam vlastností ve tvaru klíč = hodnota)
- XML
Aplikace byla úspěšně testována v následujících verzích MS Windows: XP, 7, 10 a 11. Nejnovější verze aplikace je vždy k dispozici ke stažení z Stažení strana.
Plnou funkčnost aplikace lze zkontrolovat – bez nutnosti vytvoření účtu – pomocí poskytnutého Test API
Pro použití doplňku v produkčním API si musíte založit účet na webu viesapi.eu, zakoupit si minimálně Business plán a vygenerovat API klíč a identifikátor API klíče.
Proces registrace a nastavení účtu a také generování klíčů byl popsán na Dokumentace webová stránka.
Aktivace
Sdílený spustitelný program viesapi-cli.exe
nevyžaduje instalaci a nemusí být provozován pod účtem s oprávněními správce. Chcete-li spustit program, vyberte Command Prompt
aplikace z Start
menu nebo typu cmd
v Search programs and files
pole a stiskněte Enter:
Po spuštění konzoly přejděte do adresáře, kde se nachází soubor zip viesapi-cli.exe
byl stažen a rozbalen.
Po spuštění programu bez zadání parametrů se zobrazí okno nápovědy.
Konfigurace
Spuštění viesapi-cli.exe
aplikace bez uvedení API key ID
a API key
umožňuje dotazovat se na testovací prostředí (více podrobností na Otestujte VIES API strana).
Pro připojení k produkčnímu prostředí je nutné vyvolat viesapi-cli.exe
aplikace s autentizačními parametry, kterými jsou:
keyid
– parametr by měl obsahovat identifikátor API klíče (ID) vygenerovaný na účtu na webu viesapi.eu,key
– parametr by měl obsahovat API klíč (Key) vygenerovaný na účtu na webu viesapi.eu.
Podrobnosti o generování identifikátoru a klíče jsou popsány na Dokumentace strana. Níže je uveden příklad volání aplikace s parametry ověřování (keyid
a key
):
viesapi-cli.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -vies -format xml
Syntaxe volání
Syntaxe volání viesapi-cli.exe
naprogramovat:
viesapi-cli.exe <action>
Dostupné akce:
-help
– popis parametrů volání programu
-vies
– aktuální stav systému VIES
-account
– stav běžného účtu
-data
– získat firemní data z VIES
-data-parsed
– získat firemní data z VIES s analyzovanými daty
-batch-upload
– nahrát dávku DIČ a získat dávkový token
-batch-download
– zkontrolovat výsledek dávky a stáhnout data
Dostupné možnosti:
-keyid string
– Identifikátor klíče API
-key string
– API klíč
-euvat number
– DIČ EU s předvolbou země
-token string
– hodnota dávkového tokenu
-format type
– typ výstupního formátu (json, prop, xml), výchozí: json
-file-in path
– cesta k vstupnímu souboru
-file-out path
– cesta k výstupnímu souboru
-proxy url
– Konfigurace HTTP proxy (jako URL http://user:password@hostname:port
)
Příklady
POZORNOST! Následující příklady jsou přizpůsobeny datům shromážděným v testovacím prostředí. Chcete-li provést kontroly produkčního prostředí, přidejte –keyid
a –key
parametry s příslušnými hodnotami pro každý dotaz.
1. Zkontroluje aktuální stav systému VIES a zobrazí výsledek ve formátu XML:
viesapi-cli.exe -vies -format xml
2. Zkontroluje aktuální stav účtu a uloží výsledek do souboru JSON:
viesapi-cli.exe -account -file-out result.json
.
3. Stahuje firemní data z VIES a zobrazuje výsledek jako PROP:
viesapi-cli.exe -data -euvat PL5213003700 -format prop
4. Stahuje data z VIES analyzovaná společností a ukládá výsledek do souboru JSON:
viesapi-cli.exe -data-parsed -euvat PL5213003700 -file-out result.json
5. Nahraje dávkový soubor (jedno číslo na řádek) a obdrží dávkový token pro kontrolu výsledku:
viesapi-cli.exe -batch-upload -file-in numbers.csv
6. Zkontroluje aktuální stav dávky a uloží výsledek do souboru JSON:
viesapi-cli.exe -batch-download -token 1fd853a5-ac9e-490c-81a1-d4900a9c906c -file-out result.json