Klientrakendus viesClient.exe võimaldab üksuste (töövõtjate) kiiret ja automaatset kontrollimist käsurea tasemel (CLI / CMD) nende hetkeoleku osas VIES-süsteemis. Samuti võimaldab rakendus salvestada allalaaditud andmed faili kolmes vormingus:

  • JSON (vaikekuvavorminguks stdout)
  • XML
  • MAP (atribuudi kaardi võti = väärtus)

Rakendust on edukalt testitud järgmistes MS Windowsi versioonides: XP, 7 ja 10.

Rakenduse uusim versioon on alati allalaadimiseks saadaval saidilt 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 viesClient.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 "Search programs and files välja ja vajutage sisestusklahvi:

Pärast konsooli käivitamist minge kataloogi, kus ZIP-fail viesClient.exe laaditi alla ja pakiti lahti.

Programmi käivitamisel parameetreid määramata kuvatakse abiaken.

Seadistamine

Käivitades viesClient.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 viesClient.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):
viesClient.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -vies -euvat PL7171642051.

Helistamise süntaks

Programmi viesClient.exe helistamise süntaks:
viesClient.exe <action> [options].

Saadaolevad toimingud :
-help – programmi kutsumise parameetrite kirjeldus
-account – tagastab info viesapi.eu arvelduskonto saldo kohta
-vies – hankige VIES-ist ettevõtte andmed.

Saadaolevad valikud [valikud]:

-keyid string – API võtme identifikaator
-key string - API võti
-euvat number – EL KMKR number koos riigi eesliitega
-format type
– tagastatud andmete vorming (JSON, MAP, XML), vaikimisi: JSON
-file path
– tulemusfaili nimi ja tee, vaikimisi: viesClient.exe käivituskataloog
-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. Ettevõtte andmete allalaadimine VIES-ist ja tulemuse kuvamine konsoolil MAP-vormingus:

viesClient.exe -vies -euvat PL5213003700 -map format

2. Kuvage teave praeguse konto oleku kohta:

viesClient.exe -account.

3. HTTP-puhverserveri säte:

viesClient.exe -vies -euvat PL7272445205 -proxy http://user:password@10.0.0.1:8080