Aplikacja kliencka viesClient.exe pozwala na szybkie i automatyczne sprawdzenie podmiotów (kontrahentów) z poziomu wiersza poleceń (CLI/CMD) pod kątem ich aktualnego statusu w systemie VIES. Aplikacja umożliwia również zapisanie pobranych danych do pliku w 3 formatach:
- JSON (domyślny format wyświetlania na standardowe wyjście)
- XML
- MAP (klucz mapy atrybutów = wartość)
Aplikacja została pomyślnie przetestowana w następujących wersjach MS Windows: XP, 7 i 10.
Najnowsza wersja aplikacji jest zawsze dostępna do pobrania z Ściągnij strona.
Pełną funkcjonalność aplikacji można sprawdzić – bez konieczności zakładania konta – korzystając z udostępnionej Testuj API
Aby skorzystać z dodatku w produkcyjnym API należy założyć konto w serwisie viesapi.eu, wykupić minimum Biznesplan oraz wygenerować klucz API oraz identyfikator klucza API.
Proces rejestracji i zakładania konta oraz generowania kluczy został opisany na Dokumentacja stronie internetowej.
Aktywacja
Udostępniony program wykonywalny viesClient.exe nie wymaga instalacji i nie musi być uruchamiany na koncie z uprawnieniami administratora. Aby uruchomić program, wybierz Command Prompt aplikacja z Start menu lub typ cmd w "Search programs and files“ i naciśnij Enter:
Po uruchomieniu konsoli przejdź do katalogu, w którym znajduje się plik zip z viesClient.exe został pobrany i rozpakowany.
Uruchomienie programu bez podania parametrów powoduje wyświetlenie okna pomocy.
Konfiguracja
Uruchomienie viesClient.exe aplikacji bez określenia API key ID oraz API key umożliwia odpytywanie środowiska testowego (więcej szczegółów na temat Przetestuj API VIES strona).
Aby połączyć się ze środowiskiem produkcyjnym, konieczne jest wywołanie viesClient.exe aplikację o parametrach uwierzytelniających, którymi są:
keyid– parametr powinien zawierać identyfikator klucza API (ID) wygenerowany na koncie w serwisie viesapi.eu,key– parametr powinien zawierać klucz API (Key) wygenerowany na koncie w serwisie viesapi.eu.
Szczegóły dotyczące generowania identyfikatora i klucza opisane są na Dokumentacja strona. Poniżej przykład wywołania aplikacji z parametrami uwierzytelniania (keyid oraz key):
viesClient.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -vies -euvat PL7171642051.
Składnia wywoływania
Składnia wywołania programu viesClient.exe:
viesClient.exe <action> .
Możliwe akcje :
-help – opis parametrów wywołania programu
-account – zwraca informacje o aktualnym stanie konta viesapi.eu
-vies – uzyskaj dane firmy z VIES.
Dostępne opcje [opcje]:
-keyid string – Identyfikator klucza API
-key string - Klucz API
-euvat number – Numer VAT UE z prefiksem kraju
-format type
-file path
-proxy urlhttp://user:password@hostname:port).
Przykłady
UWAGA! Poniższe przykłady są dostosowane do danych zebranych w środowisku testowym. Aby przeprowadzić kontrolę w środowisku produkcyjnym, dodaj –keyid oraz –key parametry z odpowiednimi wartościami do każdego zapytania.
1. Pobranie danych firmy z VIES i wyświetlenie wyniku na konsoli w formacie MAP:
viesClient.exe -vies -euvat PL5213003700 -map format
2. Wyświetl informacje o aktualnym stanie konta:
viesClient.exe -account.
3. Ustawienia proxy HTTP:
viesClient.exe -vies -euvat PL7272445205 -proxy http://user:password@10.0.0.1:8080