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 (Ключ), згенерований в обліковому записі на сайті 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