200

OK

Запит успішно оброблено і повернуто результат

400

Bad Request

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

401

Unauthorized

Параметри авторизації не правильні, або не вказані взагалі.

402

PaymentRequired

Для виконання запиту необхідна оплата.

403

Forbidden

Запит вірний але в обробці відмовлено. Відповідне повідомлення з поясненнями додано до відповіді.

404

Not Found

Адреса не правильна або ресурс до якого йде запит не існує.

406

Not Acceptable

Дані передані в запиті мають не зрозумілий формат.

429

Many Requests

API повертає таку відповідь коли вичерпано обмеження запитів до ресурсу.

500

Internal Server Error

Щось зламалось.

502

Bad Gateway

Сервіс вимкнено або проходить оновлення.

Код

Текст

Пояснення

1

Could not authenticate you або Authentication credentials were not provided

Помилка аутентифікації.

2

Invalid or expired token

Недіючий або некоректний токен.

3

Your account is not permitted to access this resource

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

4

Sorry, that page does not exist

Відповідь надається разом із HTTP статусом 404. Сторінка до якої виконується запит не знайдена.

5

Paiment required

Відповідь надається разом із HTTP статусом 402. Недостатньо коштів для виконання платного запиту.

6

Parse Error або `search_date` has wrong format

Відповідь надається разом із HTTP статусом 400. Не правильний формат одного або декількох параметрів запиту.

9

Rate limit exceeded

Відповідь надається разом із HTTP статусом 429. Вичерпано кількість запитів, дозволених виконати протягом проміжку часу.

10

`code` or `passport` parameter must be provided.

У запиті не надано параметрів необхідних для виконання пошуку.

11

`passport` parameter has wrong value.

Один або більше параметрів запиту має невірний формат.

20

Internal error

Відповідь надається разом із HTTP статусом 500.

Назва

• ЦБД (primary)
• ЄДР API (external)

• Процедура входить в перелік дозволених (LLE, LLD, …, SUD)
• В процедурі використовується документ x_ultimateBeneficiaryInfo
• Учасник є юридичною особою
• award.bidders.identifier.scheme = UA-EDR
• award.status ∈ {pending_waiting, pending_admission, pending}

1. Учасник подає заявку
2. Майданчик активує заявку
3. Заявка переходить у кваліфікацію
4. ЦБД створює award
5. ЦБД перевіряє умови запуску інтеграції
6. ЦБД виконує авторизацію в ЄДР (отримує JWT токен)
7. ЦБД відправляє запит до ЄДР з code = ЄДРПОУ
8. ЄДР повертає дані КБВ (може бути список)
9. ЦБД валідовує відповідь
10. Дані відповідають моделі beneficiariesGeneralInfo
11. ЦБД записує дані в award.beneficiaries
12. Оновлює:

• award.dateModified
• procedure.dateModified
• systemDateModified

award містить список КБВ (може бути декілька)

1

When

Then

2

ЄДР повернув валідні дані

When

Then

3

Then

оновлюються всі dateModified:

• award.dateModified
• dateModified (procedure)
• systemDateModified

Назва

• ЦБД (primary)
• ЄДР API (external)

Отримано HTTP код:
400, 401, 402, 403, 404, 406, 429

1. ЦБД отримує відповідь від ЄДР
2. Перевіряє структуру
3. Дані:
   • неповні / некоректні / не мапляться
4. ЦБД НЕ записує дані

award без змін

1

When

Then

Назва

• ЦБД (primary)
• ЄДР API (external)

Отримано HTTP код:
500, 502

1. ЦБД відправляє запит
2. Отримує 500 або 502
3. Виконує retry
4. Повторює до 3 разів

після 3 невдалих спроб → fallback

• якщо успіх → UC1
• якщо ні → запис тексту помилки

1

When

Then

Система повторює запит до 3 разів

2

Then

Записується повідомлення:
"Не вдалось отримати інформацію з сервісу"

Назва

• ЦБД (primary)
• ЄДР API (external)

• Отримано HTTP код:
  400, 401, 402, 403, 404, 406, 429

1. ЦБД отримує помилку
2. Формує повідомлення
3. Відправляє в Slack канал

• команда отримує alert

1

When

Then

Відправляється повідомлення в Slack

Назва

• ЦБД (primary)
• ЄДР API (external)

Будь-яка з умов НЕ виконується:

• • процедура не з переліку
  • відсутній x_ultimateBeneficiaryInfo
  • не юрособа
  • не UA-EDR
  • статус award не підходить

1. Створюється award
2. ЦБД перевіряє умови
3. Інтеграція НЕ запускається

Жодних запитів до ЄДР

1

When

Then

запит до ЄДР не виконується

Назва

• ЦБД (primary)
• ЄДР API (external)

• Процедура входить в перелік дозволених (LLE, LLD, …, SUD)
• В процедурі використовується документ x_ultimateBeneficiaryInfo
• Учасник є юридичною особою
• award.bidders.identifier.scheme = UA-EDR
• award.status ∈ {pending_waiting, pending_admission, pending}

1. ЄДР повертає список КБВ
2. ЦБД мапить кожен запис
3. Формує list of objects
4. Записує в award.beneficiaries[]

Збережено всі КБВ

1

When

Then

Назва

• ЦБД
• ЄДР
• Адміністратор/відповідальна команда
• Slack канал

• Інтеграція з ЄДР активна
• ЦБД направляє запит до ЄДР для отримання даних КБВ
• ЄДР повертає HTTP 402
• У вимогах уже передбачено фіксацію таких помилок у Slack.

1. ЦБД направляє запит до ЄДР.
2. ЄДР повертає відповідь 402 Payment Required.
3. ЦБД фіксує факт отримання помилки.
4. ЦБД змінює внутрішній статус інтеграції з ЄДР на умовний:
   • suspended;
   • або payment_required;
   • або temporarily_disabled.
5. ЦБД припиняє направлення нових запитів до ЄДР.
6. ЦБД відправляє повідомлення в Slack канал.
7. Для нових awards, які підпадають під умови інтеграції, запит до ЄДР не виконується.
8. У відповідному полі/технічному статусі фіксується причина:
   • Запити до ЄДР тимчасово призупинено через необхідність оплати.

• Нові запити до ЄДР не направляються.
• Команда отримала повідомлення про необхідність внесення коштів.
• Дані КБВ для нових awards тимчасово не збагачуються.

1

When

Then

2

Інтеграція має статус призупинення через 402

When

Then

3

Then

Повідомлення надсилається в Slack канал.

Назва

• ЦБД
• ЄДР
• Slack канал
• Адміністратор/відповідальна команда

• Інтеграція з ЄДР активна
• ЦБД направляє запит до ЄДР
• ЄДР повертає HTTP 429
• 429 означає, що вичерпано обмеження запитів до ресурсу.

1. ЦБД направляє запит до ЄДР.
2. ЄДР повертає відповідь 429 Many Requests.
3. ЦБД фіксує помилку.
4. ЦБД призупиняє направлення нових запитів до ЄДР.
5. ЦБД відправляє повідомлення в Slack канал.
6. Нові awards, які підпадають під інтеграцію, не ініціюють запит до ЄДР.
7. Система фіксує причину призупинення:
   • Перевищено ліміт запитів до ЄДР.

• Інтеграція тимчасово зупинена.
• Нові запити до ЄДР не виконуються.
• Команда повідомлена про перевищення ліміту.

1

When

Then

2

Інтеграція призупинена через 429

When

Then

3

Then

Повідомлення надсилається в Slack канал.

Назва

• Адміністратор/відповідальна команда
• ЦБД
• ЄДР

• Інтеграція з ЄДР була призупинена через 402
• Кошти внесено / доступ до сервісу відновлено

1. Відповідальна команда вносить кошти.
2. Адміністратор ініціює відновлення інтеграції.
3. ЦБД змінює статус інтеграції з:
   • payment_required / suspended
   • на active.
4. ЦБД відновлює направлення запитів до ЄДР.
5. При створенні наступного award ЦБД знову виконує стандартну логіку запиту до ЄДР.
6. Якщо ЄДР повертає 200, дані КБВ обробляються та записуються в award.

• Інтеграція з ЄДР активна.
• Нові запити знову направляються.
• Дані КБВ можуть бути отримані та внесені в award.

1

When

Then

2

Інтеграція активна після відновлення

When

Then

3

Then

Дані записуються в award.beneficiaries

Назва

• Адміністратор/відповідальна команда
• ЦБД
• ЄДР

• Інтеграція була призупинена через 429
• Ліміт запитів поновлено або відповідальна команда підтвердила можливість повторного використання сервісу

1. Відповідальна команда перевіряє, що ліміт запитів відновлено.
2. Адміністратор активує інтеграцію.
3. ЦБД змінює статус інтеграції на active.
4. Наступні awards знову запускають запит до ЄДР.
5. Якщо ЄДР повертає успішну відповідь — дані обробляються за стандартним сценарієм.

• Запити до ЄДР відновлені.
• Система продовжує автоматичне збагачення awards даними КБВ.

1

When

And

Then

2

Інтеграція активована після 429

When

Then