The viesapi-cli.exe Klienta lietojumprogramma ļauj ātri un automātiski pārbaudīt vienību (darbuzņēmēju) pašreizējo statusu VIES sistēmā no komandrindas līmeņa (CLI / CMD). Lietojumprogramma arī ļauj saglabāt lejupielādētos datus failā 3 formātos:
- JSON
- PROP (īpašību saraksts atslēgas = vērtības formā)
- XML
Lietojumprogramma ir veiksmīgi pārbaudīta šādās MS Windows versijās: XP, 7, 10 un 11. Jaunākā lietojumprogrammas versija vienmēr ir pieejama lejupielādei no Lejupielādēt lappuse.
Pilnu aplikācijas funkcionalitāti var pārbaudīt – bez nepieciešamības izveidot kontu – izmantojot piedāvāto Testa API
Lai izmantotu pievienojumprogrammu ražošanas API, jums ir jāizveido konts vietnē viesapi.eu, jāiegādājas vismaz Biznesa plāns un jāģenerē API atslēga un API atslēgas identifikators.
Reģistrācijas un konta izveides process, kā arī atslēgu ģenerēšana ir aprakstīta vietnē Dokumentācija tīmekļa vietne.
Aktivizēšana
Koplietojama izpildāmā programma viesapi-cli.exe nav nepieciešama instalēšana, un tā nav jādarbojas ar kontu ar administratora privilēģijām. Lai palaistu programmu, atlasiet Command Prompt pieteikums no Start izvēlne vai veids cmd iekšā Search programs and files laukā un nospiediet taustiņu Enter:
Pēc konsoles palaišanas dodieties uz direktoriju, kurā atrodas zip fails viesapi-cli.exe tika lejupielādēts un izpakots.
Palaižot programmu, nenorādot parametrus, tiek parādīts palīdzības logs.
Konfigurācija
Palaižot viesapi-cli.exe pieteikums, nenorādot API key ID un API key ļauj veikt vaicājumus testa vidē (sīkāka informācija par Pārbaudiet VIES API lappuse).
Lai izveidotu savienojumu ar ražošanas vidi, ir nepieciešams izsaukt viesapi-cli.exe lietojumprogramma ar autentifikācijas parametriem, kas ir:
keyid– parametrā ir jāietver API atslēgas identifikators (ID), kas ģenerēts kontā vietnē viesapi.eu,key– parametrā ir jāietver API atslēga (Key), kas ģenerēta vietnē viesapi.eu.
Sīkāka informācija par identifikatora un atslēgas ģenerēšanu ir aprakstīta vietnē Dokumentācija lappuse. Tālāk ir parādīts lietojumprogrammas izsaukšanas piemērs ar autentifikācijas parametriem (keyid un key):
viesapi-cli.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -vies -format xml
Zvanīšanas sintakse
Izsaukuma sintakse viesapi-cli.exe programma:
viesapi-cli.exe <action>
Pieejamās darbības:
-help – programmas izsaukšanas parametru apraksts
-vies – pašreizējais VIES sistēmas statuss
-account – tekošā konta stāvoklis
-data – iegūt uzņēmuma datus no VIES
-data-parsed – iegūt uzņēmuma datus no VIES ar parsētiem datiem
-batch-upload – augšupielādēt PVN numuru partiju un saņemt partijas žetonu
-batch-download – pārbaudiet partijas rezultātu un lejupielādējiet datus
Pieejamās opcijas:
-keyid string - API atslēgas identifikators
-key string - API atslēga
-euvat number – ES PVN ID numurs ar valsts prefiksu
-token string – partijas žetona vērtība
-format type – izvades formāta tips (json, prop, xml), noklusējums: json
-file-in path – ievades faila ceļš
-file-out path – izvades faila ceļš
-proxy url - HTTP starpniekservera konfigurācija (kā URL http://user:password@hostname:port)
Piemēri
UZMANĪBU! Tālāk minētie piemēri ir pielāgoti testa vidē savāktajiem datiem. Lai veiktu ražošanas vides pārbaudes, pievienojiet –keyid un –key parametrus ar atbilstošām vērtībām katram vaicājumam.
1. Pārbauda pašreizējo VIES sistēmas statusu un rezultātu parāda XML formātā:
viesapi-cli.exe -vies -format xml
2. Pārbauda pašreizējo konta statusu un saglabā rezultātu JSON failā:
viesapi-cli.exe -account -file-out result.json.
3. Lejupielādē uzņēmuma datus no VIES un rezultātu attēlo kā PROP:
viesapi-cli.exe -data -euvat PL5213003700 -format prop
4. Lejupielādē uzņēmuma parsētos datus no VIES un saglabā rezultātu JSON failā:
viesapi-cli.exe -data-parsed -euvat PL5213003700 -file-out result.json
5. Augšupielādē partijas failu (viens numurs katrā rindā) un saņem partijas marķieri rezultātu pārbaudei:
viesapi-cli.exe -batch-upload -file-in numbers.csv
6. Pārbauda pašreizējo partijas statusu un saglabā rezultātu JSON failā:
viesapi-cli.exe -batch-download -token 1fd853a5-ac9e-490c-81a1-d4900a9c906c -file-out result.json