The viesapi-cli.exe Kliendirakendus võimaldab käsurealt (CLI / CMD) kiiresti ja automaatselt kontrollida üksuste (töövõtjate) praegust staatust VIES-süsteemis. Rakendus võimaldab teil allalaaditud andmeid ka faili salvestada kolmes vormingus:
- JSON
- PROP (omaduste loend kujul võti = väärtus)
- XML
Rakendust on edukalt testitud järgmistes MS Windowsi versioonides: XP, 7, 10 ja 11. Rakenduse uusim versioon on alati allalaadimiseks saadaval aadressilt Lae alla lehel.
Rakenduse täielikku funktsionaalsust saab kontrollida – ilma kontot loomata – kasutades selleks pakutavat Test API
Lisandmooduli kasutamiseks tootmis-API-s peate looma konto viesapi.eu veebisaidil, ostma minimaalselt Äriplaani ning genereerima API-võtme ja API-võtme identifikaatori.
Konto registreerimise ja seadistamise ning võtmete genereerimise protsessi on kirjeldatud lehel Dokumentatsioon veebisait.
Aktiveerimine
Jagatud käivitatav programm viesapi-cli.exe ei vaja installimist ja seda ei pea käivitama administraatoriõigustega konto all. Programmi käivitamiseks valige Command Prompt taotlus alates Start menüü või tüüp cmd sees Search programs and files välja ja vajutage sisestusklahvi:
Pärast konsooli käivitamist minge kataloogi, kus ZIP-fail viesapi-cli.exe laaditi alla ja pakiti lahti.
Programmi käivitamisel parameetreid määramata kuvatakse abiaken.
Seadistamine
Käivitades viesapi-cli.exe rakendust täpsustamata API key ID ja API key võimaldab teil teha päringuid testkeskkonnast (täpsemalt Testige VIES API-d leht).
Tootmiskeskkonnaga ühenduse loomiseks on vaja välja kutsuda viesapi-cli.exe rakendus autentimisparameetritega, mis on:
keyid– parameeter peaks sisaldama viesapi.eu veebisaidil kontol loodud API võtme identifikaatorit (ID),key– parameeter peaks sisaldama viesapi.eu veebisaidil kontol genereeritud API-võtit (Key).
Identifikaatori ja võtme genereerimise üksikasju kirjeldatakse lehel Dokumentatsioon lehel. Allpool on näide rakendusele autentimisparameetritega helistamisest (keyid ja key):
viesapi-cli.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -vies -format xml
Helistamise süntaks
Kutsumise süntaks viesapi-cli.exe programm:
viesapi-cli.exe <action>
Saadaval olevad toimingud:
-help – programmi kutsumise parameetrite kirjeldus
-vies – VIES-süsteemi praegune olek
-account – arvelduskonto seis
-data – hankida ettevõtte andmeid VIES-ist
-data-parsed – hankige VIES-ist ettevõtte andmeid parsitud andmetega
-batch-upload – laadige üles käibemaksukohustuslase numbrite partii ja saate partii tunnuskoodi
-batch-download – partii tulemuse kontrollimine ja andmete allalaadimine
Saadaval olevad valikud:
-keyid string – API võtme identifikaator
-key string - API võti
-euvat number – EL KMKR number koos riigi eesliitega
-token string – partii žetooni väärtus
-format type – väljundvormingu tüüp (json, prop, xml), vaikimisi: json
-file-in path – sisendfaili tee
-file-out path – väljundfaili tee
-proxy url – HTTP-puhverserveri konfiguratsioon (URL-ina http://user:password@hostname:port)
Näited
TÄHELEPANU! Järgmised näited on kohandatud testkeskkonnas kogutud andmetele. Tootmiskeskkonna kontrollimiseks lisage –keyid ja –key iga päringu jaoks sobivate väärtustega parameetrid.
1. Kontrollib VIES-süsteemi praegust olekut ja kuvab tulemuse XML-ina:
viesapi-cli.exe -vies -format xml
2. Kontrollib konto praegust olekut ja salvestab tulemuse JSON-faili:
viesapi-cli.exe -account -file-out result.json.
3. Laadib ettevõtte andmed VIES-ist alla ja kuvab tulemuse PROP-ina:
viesapi-cli.exe -data -euvat PL5213003700 -format prop
4. Laadib VIES-ist alla ettevõtte parsitud andmed ja salvestab tulemuse JSON-faili:
viesapi-cli.exe -data-parsed -euvat PL5213003700 -file-out result.json
5. Laadib üles pakkfaili (üks number rea kohta) ja saab tulemuste kontrollimiseks pakktokeni:
viesapi-cli.exe -batch-upload -file-in numbers.csv
6. Kontrollib partii praegust olekut ja salvestab tulemuse JSON-faili:
viesapi-cli.exe -batch-download -token 1fd853a5-ac9e-490c-81a1-d4900a9c906c -file-out result.json