VIES Checker CLI/CMD

ViesClient.exe-asiakassovellus mahdollistaa entiteettien (urakoitsijoiden) nopean ja automaattisen tarkistuksen komentorivitasolta (CLI / CMD) niiden nykyisen tilan VIES-järjestelmässä. Sovelluksen avulla voit myös tallentaa ladatut tiedot tiedostoon kolmessa muodossa:

  • JSON (oletusnäyttömuoto stdout)
  • XML
  • MAP (attribuutin karttaavain = arvo)

Sovellus on testattu onnistuneesti seuraavissa MS Windows -versioissa: XP, 7 ja 10.

Sovelluksen uusin versio on aina ladattavissa osoitteesta ladata sivu.

Sovelluksen koko toiminnallisuus voidaan tarkistaa – ilman tarvetta luoda tiliä – käyttämällä mukana toimitettua Testaa API

Jotta voit käyttää apuohjelmaa tuotantosovellusliittymässä, sinun on luotava tili viesapi.eu-verkkosivustolle, ostettava vähintään liiketoimintasuunnitelma ja luotava API-avain ja API-avaimen tunniste.

Tilin rekisteröinti- ja perustamisprosessi sekä avainten luonti on kuvattu sivulla Dokumentointi verkkosivusto.

Aktivointi

Jaettu suoritettava ohjelma viesClient.exe ei vaadi asennusta, eikä sitä tarvitse suorittaa järjestelmänvalvojan oikeuksilla varustetulla tilillä. Suorita ohjelma valitsemalla Command Prompt sovellus osoitteesta Start valikko tai tyyppi cmd "Search programs and files“ -kenttään ja paina Enter:

Kun olet käynnistänyt konsolin, siirry hakemistoon, jossa zip-tiedosto on viesClient.exe ladattiin ja purettiin.

Ohjelman käynnistäminen ilman parametrien määrittämistä avaa ohjeikkunan.

Kokoonpano

Käynnistetään viesClient.exe sovellus määrittelemättä API key ID ja API key voit tehdä kyselyjä testiympäristöstä (lisätietoja Testaa VIES API sivu).

Yhteyden muodostamiseksi tuotantoympäristöön on tarpeen kutsua esiin viesClient.exe sovellus todennusparametreilla, jotka ovat:

  • keyid – parametrin tulee sisältää viesapi.eu-sivustolla olevalle tilille luotu API-avaimen tunniste (ID),
  • key – parametrin tulee sisältää viesapi.eu-sivustolla olevalle tilille luotu API-avain (Key).

Yksityiskohdat tunnisteen ja avaimen luomisesta on kuvattu Dokumentointi sivu. Alla on esimerkki sovelluksen kutsumisesta todennusparametreilla (keyid ja key):
viesClient.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -vies -euvat PL7171642051.

Kutsusyntaksi

ViesClient.exe-ohjelman kutsumisen syntaksi:
viesClient.exe <action> [options].

Käytettävissä olevat keinot :
-help – ohjelman kutsuparametrien kuvaus
-account – palauttaa tiedot viesapi.eu:n käyttötilin saldosta
-vies – hanki yritystiedot VIES:ltä.

Käytettävissä olevat vaihtoehdot [vaihtoehdot]:

-keyid string – API-avaimen tunniste
-key string – API-avain
-euvat number – EU:n ALV-tunnus ja maan etuliite
-format type – palautettujen tietojen muoto (JSON, MAP, XML), oletus: JSON
-file path – nimi ja polku tulostiedostoon, oletus: viesClient.exe-ajohakemisto
-proxy url – HTTP-välityspalvelimen määritys (URL-osoitteena http://user:password@hostname:port).

Esimerkkejä

HUOMIO! Seuraavat esimerkit on mukautettu testiympäristössä kerättyihin tietoihin. Voit suorittaa tuotantoympäristön tarkistuksia lisäämällä –keyid ja –key parametrit sopivilla arvoilla jokaiselle kyselylle.

1. Yritystietojen lataaminen VIES:stä ja tuloksen näyttäminen konsolissa MAP-muodossa:

viesClient.exe -vies -euvat PL5213003700 -map format

2. Näytä tiedot nykyisestä tilin tilasta:

viesClient.exe -account.

3. HTTP-välityspalvelimen asetus:

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