The viesapi-cli.exe
Клиентското приложение позволява бърза и автоматична проверка на обекти (изпълнители) от командния ред (CLI / CMD) по отношение на текущото им състояние във VIES системата. Приложението ви позволява също така да запазите изтеглените данни във файл в 3 формата:
- JSON
- PROP (списък със свойства във формата ключ = стойност)
- XML
Приложението е успешно тествано в следните версии на MS Windows: XP, 7, 10 и 11. Най-новата версия на приложението е винаги достъпна за изтегляне от Изтегли страница.
Пълната функционалност на приложението може да се провери – без необходимост от създаване на акаунт – с помощта на предоставените Тествайте API
За да използвате добавката в производствения API, трябва да създадете акаунт на уебсайта viesapi.eu, да закупите минимум бизнес план и да генерирате API ключ и идентификатор на API ключ.
Процесът на регистрация и настройка на акаунт, както и генериране на ключове е описан на Документация уебсайт.
Активиране
Споделената изпълнима програма viesapi-cli.exe
не изисква инсталация и не е необходимо да се изпълнява под акаунт с администраторски привилегии. За да стартирате програмата, изберете Command Prompt
приложение от Start
меню или тип cmd
в Search programs and files
поле и натиснете Enter:
След като стартирате конзолата, отидете в директорията, където има zip файла viesapi-cli.exe
беше изтеглен и разопакован.
Стартирането на програмата без задаване на параметри показва помощния прозорец.
Конфигурация
Стартиране на viesapi-cli.exe
приложение, без да се уточнява API key ID
и API key
ви позволява да правите заявки в тестовата среда (повече подробности за Тествайте VIES API страница).
За да се свържете с производствената среда, е необходимо да извикате viesapi-cli.exe
приложение с параметрите за удостоверяване, които са:
keyid
– параметърът трябва да съдържа API ключ идентификатор (ID), генериран в акаунта на уебсайта viesapi.eu,key
– параметърът трябва да съдържа API ключа (Key), генериран в акаунта на уебсайта viesapi.eu.
Подробности за генериране на идентификатор и ключ са описани на Документация страница. По-долу е даден пример за извикване на приложението с параметри за удостоверяване (keyid
и key
):
viesapi-cli.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -vies -format xml
Синтаксис на извикване
Синтаксис на извикване на viesapi-cli.exe
програма:
viesapi-cli.exe <action>
Налични действия:
-help
– описание на параметрите за извикване на програмата
-vies
– текущо състояние на VIES системата
-account
– състояние на текущата сметка
-data
– получаване на фирмени данни от VIES
-data-parsed
– получаване на фирмени данни от VIES с анализирани данни
-batch-upload
– качете партида от ДДС номера и получете партиден токен
-batch-download
– проверка на резултата от партидата и изтегляне на данни
Налични опции:
-keyid string
– API ключ идентификатор
-key string
– API ключ
-euvat number
– Идентификационен номер по ДДС в ЕС с префикс на държавата
-token string
– стойност на партидния токен
-format type
– тип изходен формат (json, prop, xml), по подразбиране: json
-file-in path
– път към входния файл
-file-out path
– път към изходния файл
-proxy url
– HTTP прокси конфигурация (като URL http://user:password@hostname:port
)
Примери
ВНИМАНИЕ!! Следните примери са адаптирани към данните, събрани в тестовата среда. За да извършите проверки на производствената среда, добавете –keyid
и –key
параметри със съответните стойности за всяка заявка.
1. Проверява текущото състояние на VIES системата и показва резултата като XML:
viesapi-cli.exe -vies -format xml
2. Проверява текущото състояние на акаунта и запазва резултата в JSON файл:
viesapi-cli.exe -account -file-out result.json
.
3. Изтегля фирмени данни от VIES и показва резултата като PROP:
viesapi-cli.exe -data -euvat PL5213003700 -format prop
4. Изтегля анализирани от компанията данни от VIES и запазва резултата в JSON файл:
viesapi-cli.exe -data-parsed -euvat PL5213003700 -file-out result.json
5. Качва пакетен файл (по едно число на ред) и получава пакетен токен за проверка на резултата:
viesapi-cli.exe -batch-upload -file-in numbers.csv
6. Проверява текущото състояние на пакета и запазва резултата в JSON файл:
viesapi-cli.exe -batch-download -token 1fd853a5-ac9e-490c-81a1-d4900a9c906c -file-out result.json