...
- тип: list of objects
- може містити: кілька КБВ або fallback-записвизначення причини відсутності даних (excluded, isMissing,reason) або status має значення error .
| Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
...
- Інтеграція тригериться тільки при створенні award в модель даних beneficiariesGeneralInfo
- Запит асинхронний
- Дані записуються тільки якщо валідні
- Запис — атомарний (все або нічого):
- або записуються всі КБВ (якщо хоча б один КБД не валідний - не записується жоден)
- або записується один fallback - обʼєкт
- Основний сценарій:
- Створюється award
- Перевіряються умови
- Виконується аутентифікація в ЄДР
- Виконується запит до ЄДР
- Отримується відповідь
- Відбувається валідація
- Якщо валідно:
- запис у
award.beneficiaries[] - оновлення:
- award.dateModified
- procedure.dateModified
- systemDateModified
- запис у
- Retry (до 3 разів) тільки для: 500, 502
- retry з exponential backoff
- після 3 спроб → fallback де beneficiaries.fallback.systemReason = "Не вдалось отримати інформацію з сервісу" beneficiaries.status = error
- API_TOKEN зберігається:
- у захищеному конфігураційному середовищі
- не логуються
- не передається у відкритому вигляді - Порожній результат (200 без даних) НЕ є помилкою API, але вимагає fallback
- Асинхронність має пріоритет над статусом award — відповідь завжди обробляється
- Timeout прирівнюється до технічної помилки (500/502)
...
| Статус | Опис |
|---|---|
| processing | Триває обробка даних |
| complete | Дані внесено |
| error | Не вдалось отримати інформацію з сервісу |
Статуси інтеграції
Послідовність зміни статусів
- При створенні відправці даних для отримання даних з ЄДР про КБВ beneficiaries.status змінюється на processing
- При правильному отриманні відповіді 200 з даними beneficiaries.status змінюється з processing на complete
- При отриманні помилки beneficiaries.status змінюється з processing на error і в залежності від типу помилки відправляється повідомлення РО
Статуси інтеграції
| Статус | Опис |
|---|---|
| Статус | Опис |
active | Запити до ЄДР виконуються |
payment_required | Отримано 402, запити зупинено |
rate_limit_exceeded | Отримано 429, запити зупинено |
suspended | Інтеграцію вручну зупинено адміністратором |
| auth_error | Проблема з токеном |
| access_denied | 403 |
| invalid_request | 400/406 |
...
Обробка 401
означає невалідний або відкликаний токен
retry НЕ виконується
надсилається Slack alert
статус інтеграції → auth_error
Обробка 404
- Отримано 404
- запис в поле beneficiaries.fallback.systemReason = "Суб'єкт не знайдено в ЄДР"зміна beneficiaries.status з processing на error
Slack повідомлення
Відправляються для:
...
Назва | Отримання та запис КБВ з ЄДР в award |
| Актори |
|
| Передумови |
|
| Основний сценарій | Дані невалідні → UC2 Помилка API → UC3/UC11-15
|
| Результат | award містить список валідних КБВ (може бути декілька) |
...
Назва | Відмова у записі КБВ |
| Актори |
|
| Передумови | Отримано відповідь ЄДР |
| Основний сценарій |
|
| Альтернативний сценарій | Всі КБВ валідні → UC1 |
| Результат | award без змін |
...
Назва | Повторна спроба отримання даних |
| Актори |
|
| Передумови | Отримано HTTP код: |
| Основний сценарій |
|
| Альтернативний сценарій | Всі retry невдалі → UC4 beneficiaries.status змінюється з processing на error |
| Результат |
|
...
1 | Given | Отримано 500/502 |
When | Виконується retry | |
Then | Система повторює запит до 3 разів | |
2 | Given | Всі retry невдалі |
Then | Записується повідомлення в поле beneficiaries.fallback.systemReason: |
USE CASE 4 — Fallback
...
Назва
...
ЦБД (primary)
...
retry завершився невдачею
...
- Формується fallback-об’єкт
- Записується в beneficiaries.fallback.systemReason
...
award містить fallback
beneficiaries.status змінюється з processing на error |
...
USE CASE 4
Acceptance Criteria
...
1
...
Then
...
AND
...
Відправляється повідомлення в Slack
...
— Інтеграція не запускається
Назва | Неініціювання запиту до ЄДР |
| Актори | ЦБД (primary) |
| Передумови | Будь-яка з умов НЕ виконується:
|
| Основний сценарій |
|
| Результат | Жодних запитів до ЄДР |
Acceptance Criteria
1 | Given | Умови не виконані |
When | Створюється award | |
Then | запит до ЄДР не виконується |
...
USE CASE
...
5 — Обробка множинних КБВ
Назва | Запис кількох бенефіціарів |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| Альтернативний сценарій | хоча б один невалідний КБВ → UC2 |
| Результат | Збережено всі КБВ |
Acceptance Criteria
1 | Given | ЄДР повертає кілька КБВ |
When | Відбувається запис | |
Then | Всі КБВ зберігаються в масиві |
...
| Як | ЦБД Prozorro.Sale |
| я хочу | зупиняти направлення запитів до ЄДР після першого отримання помилки 402 або 429 |
| щоб | не створювати зайве навантаження на сервіс, не витрачати ліміти та уникати повторних неуспішних запитів до моменту відновлення доступу/поповнення коштів. |
| додатково | Після внесення коштів або відновлення ліміту система має відновити направлення запитів до ЄДР. |
USE CASE
...
6 — Зупинка запитів після отримання 402
Назва | Автоматичне призупинення інтеграції з ЄДР при помилці 402 Payment Required |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| Результат |
|
Acceptance Criteria
1 | Given | ЦБД отримала від ЄДР відповідь 402 |
When | Система обробляє відповідь | |
Then | Інтеграція з ЄДР переходить у статус призупинення. | |
2 | Given | Інтеграція має статус призупинення через |
When | Створюється новий award, який відповідає умовам інтеграції | |
Then | ЦБД не направляє запит до ЄДР. | |
3 | Given | Отримано 402 |
| When | Система фіксує помилку | |
Then | Повідомлення надсилається в Slack канал. |
...
USE CASE
...
7 — Зупинка запитів після отримання 429
Назва | Автоматичне призупинення інтеграції з ЄДР при помилці 429 Many Requests |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| Результат |
|
Acceptance Criteria
1 | Given | ЦБД отримала відповідь 429 |
When | Система обробляє відповідь | |
Then | Направлення нових запитів до ЄДР зупиняється. | |
2 | Given | Інтеграція призупинена через |
When | Створюється новий award | |
Then | ЦБД не направляє запит до ЄДР | |
3 | Given | Отримано 429 |
| When | Система обробляє помилку | |
Then | Повідомлення надсилається в Slack канал. |
...
USE CASE
...
8 — Відновлення запитів після внесення коштів
Назва | Ручне або автоматичне відновлення інтеграції з ЄДР після внесення коштів |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| Результат |
|
Acceptance Criteria
1 | Given | Інтеграція призупинена через 402 |
| And | Кошти внесено | |
When | Адміністратор активує інтеграцію | |
Then | Статус інтеграції змінюється на active. | |
2 | Given | Інтеграція активна після відновлення |
When | Створюється новий award | |
Then | ЦБД направляє запит до ЄДР | |
3 | Given | ЄДР після відновлення повертає 200 |
| When | ЦБД отримує валідні дані | |
Then | Дані записуються в |
...
USE CASE
...
9 — Відновлення після вичерпання ліміту запитів
Назва | Відновлення інтеграції після помилки 429 |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| Результат |
|
Acceptance Criteria
1 | Given | Інтеграція призупинена через 429 |
When | Ліміт запитів відновлено | |
And | Адміністратор активує інтеграцію | |
Then | ЦБД знову направляє запити до ЄДР | |
2 | Given | Інтеграція активована після |
When | Створюється award | |
Then | Запит до ЄДР виконується |
...
| Як | ЦБД Prozorro.Sale |
| я хочу | коректно обробляти всі типи помилок від ЄДР (400, 401, 403, 404, 406, 500, 502) |
| щоб | забезпечити стабільну роботу системи, не втрачати дані та мати можливість відновлення інтеграції |
USE CASE
...
10 — Обробка 401 Unauthorized при невалідному API Token
Назва | Автоматичне оновлення токена при помилці 401 |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| Результат |
|
Acceptance Criteria
1 | Given | Отримано 401 |
When | Система обробляє відповідь | |
Then | Retry не виконується | |
2 | Given | Отримано 401 |
When | Система фіксує помилку | |
Then | Статус інтеграції змінюється на auth_error | |
3 | Given | Отримано 401 |
When | Система фіксує помилку | |
Then | Повідомлення надсилається в Slack канал | |
4 | Given | Статус інтеграції = auth_error |
When | Створюється новий award, який відповідає умовам інтеграції | |
Then | Запит до ЄДР не виконується до заміни/актуалізації API Token |
...
USE CASE
...
11 — Помилка 400 (Bad Request)
Назва | Обробка некоректного запиту до ЄДР |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| Рішення | Виправлення формату запиту (dev fix) |
| Результат |
|
Acceptance Criteria
1 | Given | Отримано 400 |
When | Обробляється помилка | |
Then | Retry не виконується | |
And | Slack отримує повідомлення |
...
USE CASE
...
12 — Помилка 403 (Forbidden)
Назва | Обробка відсутності прав доступу |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| Рішення |
|
| Результат | Інтеграція не працює до виправлення |
Acceptance Criteria
1 | Given | Отримано 403 |
Then | Retry не виконується | |
And | Slack отримує повідомлення |
...
USE CASE
...
13 — Помилка 404 (Not Found)
Назва | Обробка відсутності суб’єкта в ЄДР |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| |
| Результат |
|
|
Acceptance Criteria
1 | Given | Отримано 404 |
Then | Retry не виконується | |
And Записує beneficiaries тільки поле beneficiaries.fallback.systemReason: | "Суб'єкт не знайдено в ЄДР" Змінює beneficiaries status з processing на error |
...
USE CASE
...
14 — Помилка 406 (Not Acceptable)
Назва | Обробка помилки формату даних |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| Рішення |
|
| Результат |
|
Acceptance Criteria
1 | Given | Отримано 406 |
Then | Retry не виконується | |
And | Slack отримує повідомлення |
...
| Як | ЦБД Prozorro.Sale |
| я хочу | оректно обробляти випадки, коли ЄДР не повертає дані або повертає пустий результат |
| щоб | забезпечити прозору причину відсутності КБВ у системі |
USE CASE
...
15 — Порожній результат (200, але без даних)
Назва | Суб’єкт не знайдений за кодом ЄДРПОУ (порожній результат) |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| Результат |
|
Acceptance Criteria
1 | Given | ЦБД отримала від ЄДР відповідь 200 |
And | Список результатів порожній | |
When | Система обробляє відповідь | |
Then | КБВ не заповнюються | |
2 | Given | Пустий результат |
Then записуєтьсяsystemReason = "Суб’єкт не знайдений за кодом ЄДРПОУ" | Змінює в beneficiaries status з processing на error |
...
User Story 5. Узгодженість даних при зміні статусу award
| Як | ЦБД Prozorro.Sale |
| я хочу | завершувати обробку запиту до ЄДР навіть якщо статус award змінився |
| щоб | уникнути втрати даних через асинхронність |
USE CASE
...
16 — Award змінив статус під час запиту
Назва | Обробка відповіді ЄДР після зміни статусу award |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| Результат |
|
Acceptance Criteria
1 | Given | Запит до ЄДР відправлено |
And | Award змінив статус | |
When | Отримано відповідь | |
Then | Відповідь обробляється | |
And | Дані записуються незалежно від поточного статусу award |
...
| Як | ЦБД Prozorro.Sale |
| я хочу | коректно обробляти timeout від ЄДР |
| щоб | забезпечити стабільність інтеграції |
USE CASE
...
17 — Timeout від ЄДР
Назва | Обробка перевищення часу очікування відповіді |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| Альтернативний сценарій |
|
| Результат |
|
Acceptance Criteria
1 | Given | Перевищено timeout |
When | Система обробляє запит | |
Then | Виконується retry | |
2 | Given | Retry неуспішний |
Then | Записується fallback |
...
| Як | ЦБД Prozorro.Sale |
| я хочу | Не обробляти старі awards після відновлення інтеграції |
| щоб | Уникнути неочікуваного навантаження та складної логіки в межах POC |
USE CASE
...
18 — Відсутність ретро-обробки
Назва | Обробка перевищення часу очікування відповіді |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| Альтернативний сценарій |
|
| Результат |
|
Acceptance Criteria
1 | Given | Інтеграція була зупинена |
And | Існують awards без КБВ | |
When | Інтеграція відновлена | |
Then | Обробляються тільки нові awards | |
2 | Given | Існують старі awards |
Then | Вони НЕ обробляються автоматично |
...
| Як | Адміністратор ЦБД Prozorro.Sale |
| я хочу | Мати можливість вручну керувати інтеграцією |
| щоб | Контролювати її роботу незалежно від автоматичних сценаріїв |
USE CASE
...
19 — Ручна зупинка інтеграції
Назва | Зупинка інтеграції через Адміністративну панель |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| Результат |
|
Acceptance Criteria
1 | Given | Інтеграція активна |
When | Адміністратор її зупиняє | |
Then | Статус = suspended | |
And | Запити до ЄДР не виконуються |
...
USE CASE
...
20 — Ручне відновлення інтеграції
Назва | Відновлення інтеграції через Адміністративну панель |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| Результат |
|
Acceptance Criteria
1 | Given | Інтеграція зупинена |
When | Адміністратор її відновлює | |
Then | Статус = active |
...
Назва | Зупинка інтеграції через Адміністративну панель |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| Альтернативний сценарій | Інтеграція глобально зупинена → ручний запуск дозволений |
| Результат | beneficiaries оновлено |
Acceptance Criteria
1 | Given | Обрано award |
When | Адміністратор запускає інтеграцію | |
Then | Виконується запит до ЄДР | |
And | beneficiaries перезаписуються |
...
Назва | Зупинка інтеграції через Адміністративну панель |
| Актори |
|
| Передумови |
|
| Основний сценарій |
|
| Альтернативний сценарій | перевищено ліміт → операція блокується |
| Результат | всі awards оброблені асинхронно |
Acceptance Criteria
1 | Given | Обрано список awards |
When | Запускається обробка | |
Then | Кожен award обробляється незалежно | |
2 | Given | Масовий запуск |
| Then | Обробка виконується через чергу |
...