Список изменений

Все значимые изменения в этом проекте будут документированы в этом файле. Изменения, затрагивающие непосредственно версию кода API дополнительно будут маркироваться номером этой версии.

[1.12.7] - 2025-12-19

Изменено

• Изменено значение лимита на частоту запросов - максимум 60 запросов в минуту на пользователя, со скользящим окном 1 минута (допускается кратковременное превышение выше 10 запросов/сек). При превышении лимита API возвращает 429 Too Many Requests.
• Параметр PerPage во всех запросах ограничен максимальным значением 100. При попытке запросить больше записей API возвращает 400 Bad Request. Необходимо обновить клиентский код для использования пагинации со значениями не превышающими лимит.

Добавлено

• При систематическом превышении лимитов частоты запросов (3 нарушения за 5 минут) пользователь автоматически блокируется. Первое нарушение - временная блокировка на 1 час, повторное - перманентная блокировка.

[1.11.2] - 2025-09-29

Изменено

• В методах GetStatisticSummingPeriodByVoucherId и GetStatisticSummingDayByVoucherId изменён параметр по умолчанию на IncludeAnomalyData = false.

[1.11.1] - 2025-09-23

Добавлено

• В методы GetStatisticSummingPeriodByVoucherId и GetStatisticSummingDayByVoucherId добавлен параметр IncludeAnomalyData, позволяющий отфильтровать возвращаемые данные по наличию аномалий, влияющих на качество данных (severity >= 3), и в ответ добавлен флаг hasAnomaly показывающий наличие аномалии.

Измененно

• В методе GetStatisticSummingPeriodByVoucherId добавлено поведение, при котором в случае установки в запросе параметра IncludeAnomalyData = false и фактического наличия данных, в ответ вернётся ошибка 422 (данные за запрошенный период есть, но они не возвращены из-за параметров запроса).

[1.10.5] - 2025-08-18

Добавлено

• В метод GetStatisticSummingPeriodByVoucherId добавлено поле TotalDistance, содержащее расчётный пробег по GPS.

Измененно

• В методе GetStatisticSummingPeriodByVoucherId основные поля ответа сделаны nullable, вместо fallback-ответа при отсутствии данных во всех источниках добавлена ошибка 404.

2025-08-04

Измененно

• Дополнен пошаговый гайд "Использование эндпоинтов скоринга" в секции работы с эндпойнтом GetStatisticSummingDayByVoucherId.

[1.9.3] - 2025-07-01

Добавлено

• В методы GetStatisticSummingPeriodByVoucherId и GetStatisticSummingDayByVoucherId добавлен опциональный объект recommendations, содержащий рекомендации по улучшению скоринга.
• Добавлен пошаговый гайд "Использование эндпоинтов скоринга".

Измененно

• В методе GetStatisticSummingPeriodByVoucherId данные по авариям перенесены в опциональный объект crashData.

[1.7.0] - 2025-06-16

Измененно

• Оптимизирована внутренняя логика метода GetStatisticSummingPeriodByVoucherId с целью повышения его быстродействия: начальная проверка на наличие данных, использование дневных агрегатов при запросе периодов более суток.

[1.6.2] - 2025-05-05

Добавлено

• В контроллер Аномалий добавлены методы GetAnomalyStatus и GetAnomalyHistory.
• В контроллер Биллинга добавлены методы GetBillingVouchersCount и GetBillingVouchersDetails.

Измененно

• Расширен объект VoucherTableResponseItem метода GetVoucherTable - добавлены данные по последним аномалиям.

[1.4.18] - 2025-03-10

Добавлено

• Добавлена swagger-документация в код метода GetStatisticSummingPeriodByVoucherId.
• Добавлен пошаговый гайд "Жизненный цикл ваучера".

Измененно

• Переработаны ссылки на методы в гайдах.

[1.4.17] - 2025-03-07

Первоначальный выпуск

• Опубликована документация с описанием основных функций, включая работу с ваучерами, скорингом, авариями и справочниками.