The viesapi-cli.exe Kliento programa leidžia greitai ir automatiškai patikrinti subjektų (rangovų) dabartinę būseną VIES sistemoje iš komandinės eilutės (CLI / CMD). Programa taip pat leidžia išsaugoti atsisiųstus duomenis faile 3 formatais:
- JSON
- PROP (savybių sąrašas rakto = reikšmės forma)
- XML
Programa buvo sėkmingai išbandyta šiose MS Windows versijose: XP, 7, 10 ir 11. Naujausią programos versiją visada galima atsisiųsti iš parsisiųsti puslapį.
Visą aplikacijos funkcionalumą galima patikrinti – nereikia susikurti paskyros – naudojant pateiktą Bandomasis API
Norėdami naudoti priedą gamybinėje API, turite susikurti paskyrą viesapi.eu svetainėje, įsigyti minimalų Verslo planą ir sugeneruoti API raktą bei API rakto identifikatorių.
Paskyros registravimo ir nustatymo bei raktų generavimo procesas aprašytas Dokumentacija Interneto svetainė.
Aktyvinimas
Bendrinama vykdomoji programa viesapi-cli.exe nereikia įdiegti ir nebūtina paleisti naudojant administratoriaus teises turinčią paskyrą. Norėdami paleisti programą, pasirinkite Command Prompt paraiška iš Start meniu arba tipą cmd į Search programs and files laukelį ir paspauskite Enter:
Paleidę konsolę, eikite į katalogą, kuriame yra ZIP failas viesapi-cli.exe buvo atsisiųstas ir išpakuotas.
Paleidus programą nenurodant parametrų, parodomas pagalbos langas.
Konfigūracija
Paleidžiant viesapi-cli.exe paraiška nenurodant API key ID ir API key leidžia pateikti užklausą bandymo aplinkoje (daugiau informacijos apie Išbandykite VIES API puslapis).
Norint prisijungti prie gamybinės aplinkos, būtina iškviesti viesapi-cli.exe programa su autentifikavimo parametrais, kurie yra:
keyid– parametre turi būti API rakto identifikatorius (ID), sugeneruotas paskyroje viesapi.eu svetainėje,key– parametre turi būti API raktas (Key), sugeneruotas paskyroje viesapi.eu svetainėje.
Išsami informacija apie identifikatoriaus ir rakto generavimą aprašyta Dokumentacija puslapį. Žemiau pateikiamas programos iškvietimo su autentifikavimo parametrais pavyzdys (keyid ir key):
viesapi-cli.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -vies -format xml
Skambinimo sintaksė
Iškvietimo sintaksė viesapi-cli.exe programa:
viesapi-cli.exe <action>
Galimi veiksmai:
-help – programos iškvietimo parametrų aprašymas
-vies – dabartinė VIES sistemos būsena
-account – einamosios sąskaitos būsena
-data – gauti įmonės duomenis iš VIES
-data-parsed – gauti įmonės duomenis iš VIES su išanalizuotais duomenimis
-batch-upload – įkelti PVM mokėtojų kodų paketą ir gauti paketo prieigos raktą
-batch-download – patikrinkite partijos rezultatą ir atsisiųskite duomenis
Galimos parinktys:
-keyid string – API rakto identifikatorius
-key string - API raktas
-euvat number – ES PVM mokėtojo kodas su šalies prefiksu
-token string – partijos žetono vertė
-format type – išvesties formato tipas (json, prop, xml), numatytasis: json
-file-in path – įvesties failo kelias
-file-out path – išvesties failo kelias
-proxy url – HTTP tarpinio serverio konfigūracija (kaip URL http://user:password@hostname:port)
Pavyzdžiai
DĖMESIO! Šie pavyzdžiai yra pritaikyti duomenims, surinktiems bandymo aplinkoje. Norėdami patikrinti gamybos aplinką, pridėkite –keyid ir –key parametrus su atitinkamomis reikšmėmis kiekvienai užklausai.
1. Patikrina dabartinę VIES sistemos būseną ir rezultatą pateikia XML formatu:
viesapi-cli.exe -vies -format xml
2. Patikrina dabartinę paskyros būseną ir rezultatą išsaugo JSON faile:
viesapi-cli.exe -account -file-out result.json.
3. Atsisiunčia įmonės duomenis iš VIES ir rezultatą rodo kaip PROP:
viesapi-cli.exe -data -euvat PL5213003700 -format prop
4. Atsisiunčia įmonės išanalizuotus duomenis iš VIES ir išsaugo rezultatą JSON faile:
viesapi-cli.exe -data-parsed -euvat PL5213003700 -file-out result.json
5. Įkelia paketinį failą (po vieną numerį eilutėje) ir gauna paketinį prieigos raktą rezultatams patikrinti:
viesapi-cli.exe -batch-upload -file-in numbers.csv
6. Patikrina dabartinę partijos būseną ir rezultatą išsaugo JSON faile:
viesapi-cli.exe -batch-download -token 1fd853a5-ac9e-490c-81a1-d4900a9c906c -file-out result.json