The viesapi-cli.exe asiakassovellus mahdollistaa yksiköiden (urakoitsijoiden) nopean ja automaattisen tarkistamisen komentoriviltä (CLI / CMD) niiden nykyisen tilan suhteen VIES-järjestelmässä. Sovellus mahdollistaa myös ladattujen tietojen tallentamisen tiedostoon kolmessa eri muodossa:

  • JSON
  • PROP (ominaisuuksien luettelo muodossa avain = arvo)
  • XML

Sovellus on testattu onnistuneesti seuraavissa MS Windows -versioissa: XP, 7, 10 ja 11. 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 viesapi-cli.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 ...ssa Search programs and files -kenttään ja paina Enter:

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

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

Kokoonpano

Käynnistetään viesapi-cli.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 viesapi-cli.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):

viesapi-cli.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -vies -format xml

Kutsusyntaksi

Kutsun syntaksi viesapi-cli.exe ohjelmoida:

viesapi-cli.exe <action> [options]

Käytettävissä olevat toiminnot:

-help – ohjelman kutsuparametrien kuvaus
-vies – VIES-järjestelmän nykyinen tila
-account – nykyinen tilin tila
-data – hakea yritystietoja VIES-järjestelmästä
-data-parsed – hakea yrityksen tietoja VIES:stä jäsennetyillä tiedoilla
-batch-upload – lataa erä ALV-numeroita ja hae erätunniste
-batch-download – tarkista erän tulos ja lataa tiedot

Saatavilla olevat vaihtoehdot:

-keyid string – API-avaimen tunniste
-key string – API-avain
-euvat number – EU:n ALV-tunnus ja maan etuliite
-token string – erän tokenin arvo
-format type – tulostusmuodon tyyppi (json, prop, xml), oletusarvo: json
-file-in path – syöttötiedoston polku
-file-out path – lähtötiedoston polku
-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. Tarkistaa VIES-järjestelmän nykyisen tilan ja näyttää tuloksen XML-muodossa:

viesapi-cli.exe -vies -format xml

2. Tarkistaa tilin nykyisen tilan ja tallentaa tuloksen JSON-tiedostoon:

viesapi-cli.exe -account -file-out result.json.

3. Lataa yrityksen tiedot VIES-järjestelmästä ja näyttää tuloksen PROP-muodossa:

viesapi-cli.exe -data -euvat PL5213003700 -format prop

4. Lataa yrityksen jäsentämät tiedot VIES-järjestelmästä ja tallentaa tuloksen JSON-tiedostoon:

viesapi-cli.exe -data-parsed -euvat PL5213003700 -file-out result.json

5. Lataa eräajotiedoston (yksi numero riviä kohden) ja vastaanottaa erätunnisteen tulosten tarkistamista varten:

viesapi-cli.exe -batch-upload -file-in numbers.csv

6. Tarkistaa erän nykyisen tilan ja tallentaa tuloksen JSON-tiedostoon:

viesapi-cli.exe -batch-download -token 1fd853a5-ac9e-490c-81a1-d4900a9c906c -file-out result.json