Початок роботи

Switch to English

Цей розділ описує загальний порядок інтеграції з API UKRCARD.

API UKRCARD дозволяють клієнтам інтегруватися з платіжними та картковими сервісами компанії через захищену API-взаємодію.

Залежно від бізнес-сценарію клієнт може використовувати один або декілька API-напрямів:

WSGATE (Payments API) - API для платіжних операцій;
UAPI (Cards & Accounts API) - API для роботи з картками, рахунками та пов’язаними сервісами.

Детальний опис методів, форматів запитів, відповідей та параметрів підключення наведено у відповідних розділах документації кожного API.

1. Загальний процес інтеграції

Інтеграція з API UKRCARD виконується поетапно - від первинного звернення до запуску в продуктивному середовищі.

Типовий процес включає:

1. первинне звернення до UKRCARD;
2. узгодження бізнес-моделі та сценаріїв використання API;
3. ознайомлення з документацією;
4. перевірку базової логіки в Mock / Пісочниці;
5. інтеграційне тестування в Sandbox / тестовому середовищі;
6. підготовку продуктивного підключення;
7. перехід до Live / продуктивного середовища.

Залежно від обраного API, сервісу та інтеграційного сценарію окремі етапи можуть бути адаптовані або проходити паралельно.

2. Зв’яжіться з нами

Щоб розпочати інтеграцію, зверніться до команди UKRCARD:

Після звернення наша команда зв’яжеться з вами для уточнення бізнесових і технічних параметрів інтеграції.

3. Первинне узгодження

На першому етапі необхідно узгодити:

▪️ бізнес-модель клієнта;
▪️ API або сервіси, які планується використовувати;
▪️ типи операцій;
▪️ очікувані сценарії використання;
▪️ географію платежів або обслуговування;
▪️ технічні контакти з боку клієнта;
▪️ очікуваний графік інтеграції;
▪️ вимоги до тестування та продуктивного запуску.

Після цього UKRCARD надає необхідну інформацію для подальшої роботи з відповідним API.

4. Етапи інтеграції

Етап	Середовище	Призначення
1	Mock / Емуляція	Первинне ознайомлення зі структурою API, форматами запитів і відповідей та перевірка базової логіки інтеграції
2	Sandbox / Тестове середовище	Повноцінне інтеграційне тестування погоджених бізнес-сценаріїв
3	Live / Продуктивне середовище	Виконання реальних операцій після успішного завершення тестування та погодження готовності

Доступність середовищ, тестові та продуктивні дані та порядок отримання доступу визначаються окремо для кожного API та інтеграційного сценарію.

4.1. Mock / Емуляція

Mock / Емуляція використовується для початкового ознайомлення з API та підготовки інтеграції на стороні клієнта.

На цьому етапі можна:

▪️ ознайомитися зі структурою API-запитів і відповідей;
▪️ перевірити базову логіку викликів;
▪️ реалізувати первинну взаємодію з API;
▪️ протестувати типові сценарії без впливу на реальні операції.

Mock / Пісочниця не замінює повноцінне інтеграційне тестування.

4.2. Sandbox / Тестове середовище

Тестове середовище використовується для перевірки інтеграції в умовах, наближених до продуктивного використання.

На цьому етапі зазвичай виконуються:

▪️ налаштування доступу до відповідного API;
▪️ налаштування захищеного з’єднання;
▪️ перевірка API-методів і параметрів запитів;
▪️ тестування погоджених бізнес-сценаріїв;
▪️ перевірка обробки відповідей і помилок;
▪️ перевірка callback / webhook-повідомлень, якщо вони використовуються;
▪️ погодження результатів тестування з командою UKRCARD.

Детальні умови тестування та параметри підключення наведені в документації відповідного API.

4.3. Live / Продуктивне середовище

Після успішного тестування сторони погоджують перехід до продуктивного середовища.

Перед запуском необхідно переконатися, що:

▪️ реалізовано та перевірено погоджені сценарії;
▪️ клієнтська система коректно формує API-запити та обробляє API-відповіді;
▪️ налаштовано продуктивний доступ до відповідного API;
▪️ визначено відповідальних технічних контактів;
▪️ погоджено дату, порядок та комунікації під час запуску.

Продуктивне середовище призначене для виконання реальних операцій.

Параметри доступу до продуктивного середовища, включно з URL, сертифікатами та мережевими вимогами, надаються відповідно до обраного API та погодженого способу підключення.

5. Наступні кроки

Для продовження роботи:

1. Оберіть потрібний напрям інтеграції: WSGATE або UAPI.
2. Ознайомтеся з описом API та доступними методами.
3. Перейдіть до розділу «Підключення та mTLS-сертифікати» у відповідній API-гілці.
4. Узгодьте доступ до тестового середовища.
5. Проведіть інтеграційне тестування.
6. Погодьте перехід до продуктивного використання.