The viesapi-cli.exe Aplikacja kliencka umożliwia szybkie i automatyczne sprawdzanie podmiotów (kontrahentów) z poziomu wiersza poleceń (CLI/CMD) pod kątem ich aktualnego statusu w systemie VIES. Aplikacja umożliwia również zapis pobranych danych do pliku w 3 formatach:
- JSON
- PROP (lista właściwości w formie klucz = wartość)
- XML
Aplikacja została pomyślnie przetestowana w następujących wersjach systemu MS Windows: XP, 7, 10 i 11. Najnowszą wersję aplikacji można zawsze pobrać ze strony Ś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 viesapi-cli.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 viesapi-cli.exe został pobrany i rozpakowany.
Uruchomienie programu bez podania parametrów powoduje wyświetlenie okna pomocy.
Konfiguracja
Uruchomienie viesapi-cli.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 viesapi-cli.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):
viesapi-cli.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -vies -format xml
Składnia wywoływania
Składnia wywołania viesapi-cli.exe program:
viesapi-cli.exe <action>
Dostępne akcje:
-help – opis parametrów wywołania programu
-vies – aktualny stan systemu VIES
-account – aktualny stan konta
-data – pobierz dane firmy z VIES
-data-parsed – pobierz dane firmy z VIES z przeanalizowanymi danymi
-batch-upload – prześlij partię numerów VAT i pobierz token partii
-batch-download – sprawdź wynik partii i pobierz dane
Dostępne opcje:
-keyid string – Identyfikator klucza API
-key string - Klucz API
-euvat number – Numer VAT UE z prefiksem kraju
-token string – wartość tokena partii
-format type – typ formatu wyjściowego (json, prop, xml), domyślnie: json
-file-in path – ścieżka do pliku wejściowego
-file-out path – ścieżka do pliku wyjściowego
-proxy url – Konfiguracja proxy HTTP (jako URL http://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. Sprawdza aktualny stan systemu VIES i wyświetla wynik w formacie XML:
viesapi-cli.exe -vies -format xml
2. Sprawdza aktualny stan konta i zapisuje wynik w pliku JSON:
viesapi-cli.exe -account -file-out result.json.
3. Pobiera dane firmy z VIES i wyświetla wynik jako PROP:
viesapi-cli.exe -data -euvat PL5213003700 -format prop
4. Pobiera przeanalizowane dane firmy z VIES i zapisuje wynik w pliku JSON:
viesapi-cli.exe -data-parsed -euvat PL5213003700 -file-out result.json
5. Przesyła plik wsadowy (jeden numer na wiersz) i odbiera token wsadowy w celu sprawdzenia wyników:
viesapi-cli.exe -batch-upload -file-in numbers.csv
6. Sprawdza aktualny stan partii i zapisuje wynik w pliku JSON:
viesapi-cli.exe -batch-download -token 1fd853a5-ac9e-490c-81a1-d4900a9c906c -file-out result.json