Az viesapi-cli.exe A kliensalkalmazás lehetővé teszi az entitások (vállalkozók) gyors és automatikus ellenőrzését parancssorból (CLI / CMD) a VIES rendszerben lévő aktuális állapotuk szempontjából. Az alkalmazás lehetővé teszi a letöltött adatok fájlba mentését 3 formátumban:

  • JSON
  • PROP (tulajdonságok listája kulcs = érték formában)
  • XML

Az alkalmazást sikeresen tesztelték a következő MS Windows verziókban: XP, 7, 10 és 11. Az alkalmazás legújabb verziója mindig letölthető a következő címről: Letöltés oldalon.

Az alkalmazás teljes funkcionalitása ellenőrizhető – fiók létrehozása nélkül – a megadott segítségével Teszt API

A bővítmény éles API-ban való használatához létre kell hoznia egy fiókot a viesapi.eu webhelyen, meg kell vásárolnia legalább az Üzleti tervet, és létre kell hoznia egy API kulcsot és API kulcs azonosítót.

A fiók regisztrációjának és beállításának, valamint a kulcsok generálásának folyamatát a Dokumentáció weboldal.

Aktiválás

A megosztott végrehajtható program viesapi-cli.exe nem igényel telepítést, és nem kell rendszergazdai jogosultságokkal rendelkező fiók alatt futtatni. A program futtatásához válassza ki a Command Prompt alkalmazás a Start menü vagy típus cmd a Search programs and files mezőbe, és nyomja meg az Enter billentyűt:

A konzol elindítása után lépjen abba a könyvtárba, ahol a zip fájl található viesapi-cli.exe letöltve és kicsomagolva.

A program elindításakor a paraméterek megadása nélkül megjelenik a súgóablak.

Konfiguráció

Elindítva a viesapi-cli.exe alkalmazás megadása nélkül API key ID és API key lehetővé teszi a tesztkörnyezet lekérdezését (további részletek a Tesztelje a VIES API-t oldal).

A termelési környezethez való csatlakozáshoz ki kell hívni a viesapi-cli.exe alkalmazás hitelesítési paramétereivel, amelyek a következők:

  • keyid – a paraméternek tartalmaznia kell a viesapi.eu webhelyen található fiókban generált API kulcs azonosítót (ID),
  • key – a paraméternek tartalmaznia kell a viesapi.eu weboldalon lévő fiókon generált API kulcsot (Key).

Az azonosító és a kulcs létrehozásának részletei a következő oldalon találhatók: Dokumentáció oldalon. Az alábbiakban egy példa látható az alkalmazás hitelesítési paraméterekkel történő meghívására (keyid és key):

viesapi-cli.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -vies -format xml

Szintaxis hívása

A hívás szintaxisa viesapi-cli.exe program:

viesapi-cli.exe <action> [options]

Elérhető műveletek:

-help – programhívási paraméterek leírása
-vies – a VIES rendszer aktuális állapota
-account – folyószámla állapota
-data – cégadatok lekérése a VIES rendszerből
-data-parsed – vállalati adatok lekérése a VIES-ből elemzett adatokkal
-batch-upload – adószámok kötegelt feltöltése és kötegelt tokenek beszerzése
-batch-download – Ellenőrizze a kötegelt eredményt és töltse le az adatokat

Elérhető opciók:

-keyid string – API kulcs azonosító
-key string – API kulcs
-euvat number – EU-s áfaazonosító szám ország előtaggal
-token string – kötegelt token értéke
-format type – kimeneti formátum típusa (json, prop, xml), alapértelmezett: json
-file-in path – bemeneti fájl elérési útja
-file-out path – kimeneti fájl elérési útja
-proxy url – HTTP-proxy konfiguráció (URL-ként http://user:password@hostname:port)

Példák

FIGYELEM! A következő példák a tesztkörnyezetben gyűjtött adatokhoz igazodnak. Az éles környezet ellenőrzéséhez adja hozzá a –keyid és –key paramétereket a megfelelő értékekkel minden lekérdezéshez.

1. Ellenőrzi a VIES rendszer aktuális állapotát, és XML formátumban megjeleníti az eredményt:

viesapi-cli.exe -vies -format xml

2. Ellenőrzi a fiók aktuális állapotát, és az eredményt JSON fájlba menti:

viesapi-cli.exe -account -file-out result.json.

3. Letölti a cégadatokat a VIES-ből, és az eredményt PROP-ként jeleníti meg:

viesapi-cli.exe -data -euvat PL5213003700 -format prop

4. Letölti a VIES rendszerből a cég által elemzett adatokat, és az eredményt JSON fájlba menti:

viesapi-cli.exe -data-parsed -euvat PL5213003700 -file-out result.json

5. Feltölt egy kötegelt fájlt (soronként egy szám), és kap egy kötegelt tokent az eredmény ellenőrzéséhez:

viesapi-cli.exe -batch-upload -file-in numbers.csv

6. Ellenőrzi a köteg aktuális állapotát, és az eredményt JSON fájlba menti:

viesapi-cli.exe -batch-download -token 1fd853a5-ac9e-490c-81a1-d4900a9c906c -file-out result.json