Документація VIES API

вступ

Сервіс Viesapi.eu надає вибрані дані підприємців за допомогою, зокрема, веб-сервісів, бібліотек програмування та спеціальних програм. Використовуючи доступне програмне забезпечення (бібліотеки, програми та надбудову Excel), ваші клієнти зможуть:

  • перевірити статус номеру ПДВ підрядників у системі VIES,
  • завантажити реквізити компанії з системи VIES,
  • автоматичне заповнення форм рахунків-фактур,

найшвидшим способом.

У цьому документі детально описано, які кроки слід зробити для належної інтеграції з сервісом viesapi.eu.

Увага! Повну функціональність можна перевірити за допомогою наданого Перевірте VIES API. За допомогою API TEST можна перевірити всі функції, які пропонуються в платних планах без необхідності створювати обліковий запис.

Щоб отримати доступ до робочого інтерфейсу API, виконайте наведені нижче дії.

Першим кроком є реєстрація в системі та створення облікового запису. Завдяки чому можна буде завантажити програмне забезпечення та надалі налаштувати його для належного зв’язку з веб-сервісами, які надає сервіс viesapi.eu.

Реєстрація

Обов’язкова реєстрація суб’єкта, який бажає використовувати функціональність сервісу viesapi.eu. Для цього перейдіть до Реєстрація сторінку та заповніть відповідну форму. Передумовою користування сервісом viesapi.eu є прийняття правил. Правильно заповнивши форму та натиснувши кнопку Зареєструватися кнопка створить обліковий запис у сервісі viesapi.eu та його автоматичну активацію.

Логін

Вхід в активований обліковий запис можливий після входу в Вкладка входу і введення адреси електронної пошти та пароля, визначених під час реєстрації. Після правильної аутентифікації можна керувати обліковим записом. Користувач може генерувати ідентифікатори та ключі доступу до свого облікового запису, які використовуються для його автентифікації в системі.

Генерація ідентифікатора (identifier) і ключа доступу (key)

Під час першого входу an identifier генерується автоматично разом із відповідними key. The identifier є загальнодоступним і не потребує охорони, тоді як key є приватним і не має бути доступним третім особам. Крім того, з метою підвищення безпеки користувач може ввести IP address звідки можуть надходити запити. Це може бути, наприклад, IP-адреса інтернет-магазину. Немає обмежень на кількість згенерованих пар ключів та ідентифікаторів. Якщо користувач не хоче використовувати будь-яку пару ідентифікатор-ключ, він може вимкнути її, змінивши її статус.

Ключі API

Наразі доступні методи доступу VIES API

Нижче ми представляємо можливі методи доступу до VIES API. Будь ласка, клацніть на заголовок або посилання на документацію, щоб дізнатися більше.

1. Бібліотеки програмування: PHP, .NET (C#, Visual Basic, SQL Server, Access, Dynamics, FoxPro), Python, Java, C/C++, JavaScript

Технічна документація та детальний опис використання бібліотек доступні в Документація вкладка.

Файли бібліотек можна завантажити з посилання на веб-сайт Завантажити.

2. Надбудова Microsoft Excel VIES API

Для людей, які щодня використовують програму Excel, ми підготували просту у використанні надбудову. Це дозволяє ефективно (без знань програмування) перевіряти статус суб’єкта господарювання в білому списку, реєстрі платників ПДВ і системі VIES, а також шукати та завантажувати дані суб’єктів господарювання та перевіряти їх поточний статус діяльності.

Деталі встановлення, налаштування та використання на Надбудова MS Excel VIES API сторінки.

3. Перевірка ПДВ ЄС (GUI)

Додаток VIES Checker дозволяє завантажувати будь-який файл CSV для перевірки суб’єктів (підрядників), чиї номери ПДВ ЄС збережені у файлі CSV, щодо їх статусу в системі VIES.

Деталі встановлення, налаштування та використання описані безпосередньо на Додаток VIES Checker сторінки.

Програма не потребує інсталяції та прав адміністратора для запуску. Ви можете завантажити його з Завантажити сторінки.

4. Перевірка ЄС ПДВ CLI/CMD

VIES CLI/CMD Checker — це клієнтська програма, яка дозволяє швидко й автоматично перевіряти суб’єктів (підрядників) на рівні командного рядка (CLI/CMD) щодо їх поточного статусу в системі VIES.

Деталі встановлення, налаштування та використання описані безпосередньо на VIES Checker CLI/CMD сторінки.

Програма не потребує інсталяції та прав адміністратора для запуску. Ви можете завантажити його з Завантажити сторінки.

5. REST API

Якщо ви зацікавлені в підключенні безпосередньо до нашого REST API, прочитайте інформацію, доступну на REST API сторінки.

6. Автоматичний моніторинг статусу постачальників ПДВ ЄС

Послуга автоматичної перевірки ПДВ-номерів ЄС дозволяє здійснювати повністю необслуговуваний моніторинг статусу суб’єкта в системі VIES. Дізнайтеся більше про Моніторинг сторінки.