К содержанию
CheckcraftСкачать
Практический сценарий

Как принять API у подрядчика: проверка по ТЗ и протокол

Checkcraft — программа для проверки API и логов без кода, есть бесплатная версия. Скачать без регистрации →

Демо показывает удачный путь. Ломается то, чего на демо не видно: суммы, повторы, ошибки внутри сервиса при ответе 200. Проверьте это до подписи акта.

Checkcraft ·

Поможем с первой проверкой →

Почему демо — ещё не приёмка

На демонстрации подрядчик проходит сценарий, который точно работает. Ошибки прячутся в другом: сумма считается с копейкой разницы, повторный запрос создаёт дубль, ответ 200 приходит, а внутренний шаг падает и пишет ошибку в лог. По статье 720 ГК РФ, если договор не говорит иного, заказчик, принявший работу без проверки, теряет право ссылаться на недостатки, которые можно было увидеть при обычной приёмке. Поэтому проверять нужно до подписания акта, а найденное — указывать в акте или протоколе.

Из ТЗ — в проверяемые критерии

Возьмите каждый пункт ТЗ и запишите его так, чтобы результат был «да» или «нет». Для каждой проверки укажите, откуда взято ожидаемое значение: из ТЗ, из формулы, из справочника. Значение, подсмотренное в текущем ответе API, не годится: тогда проверка подтверждает то, что сделано, а не то, что заказано. Отдельной строкой — что должно произойти внутри: запись в журнал, событие, отсутствие ошибок.

Требование из ТЗ:
  «При оплате заказа статус меняется на PAID, сумма равна сумме позиций,
   событие оплаты уходит в журнал без ошибок».

Проверки для приёмки:
  1. код ответа 200
  2. status равен PAID
  3. total равен сумме items[].amount
  4. в логе сервиса по traceId запроса нет записей ERROR
  5. повторный такой же запрос не создаёт второй платёж

Что обычно забывают проверить

ТЗ чаще описывает удачный путь. При приёмке добавьте: неверные данные — понятная ошибка 400, а не 500; нет прав — 401 или 403; повтор того же запроса — без второго платежа или заказа; пустой список и большой объём; обязательные и лишние поля в ответе. И логи: ответ 200 ничего не говорит о фоновых шагах, а запись ERROR по тому же запросу говорит.

Кто пишет проверки

Проверки для приёмки готовит сторона заказчика по ТЗ — аналитик или тот, кто отвечает за результат. Если методику пишет подрядчик по готовому продукту, она описывает то, что сделано, а не то, что заказано. Если подрядчик писал код с помощью ИИ, тесты из того же контекста повторят те же ошибки. Тесты подрядчика полезны, но для приёмки нужна независимая проверка.

Протокол

Зафиксируйте стенд и версию сборки, дату, список проверок с результатом каждой и найденные расхождения: запрос, полученный ответ, ожидание и пункт ТЗ. Такой протокол прикладывают к акту или указывают в нём недостатки — тогда на них можно ссылаться и требовать исправления. После исправления тот же набор прогоняют снова и сравнивают результат.

Протокол проверки
  Стенд и версия:   test, сборка подрядчика 1.4.2
  Дата:             14.11.2026
  Проверок:         18, прошло 16, не прошло 2
  Расхождения:
    п. 3.2 ТЗ  total = 301, ожидалось 300 (позиции 100 + 200)
    п. 3.5 ТЗ  в логе payments по traceId 4bf92f… запись ERROR: queue not available

Как это сделать в Checkcraft

Импортируйте запросы подрядчика из cURL, Postman или OpenAPI и задайте правила по пунктам ТЗ без кода: значения полей, суммы по формуле, обязательные поля. Шаг логов находит записи в Kibana по traceId запроса и проверяет их, например «записей ERROR быть не должно». Прогон даёт отчёт HTML, TXT или JUnit — это и есть протокол. Набор проверок сохраняется файлом и повторяется после каждого исправления. Связь с логами и отчёты входят в бесплатную версию, проверки в базе данных — в Pro.

Следующий шаг

Повторите это на своём API

Checkcraft — настольная программа: сохраняет проверки ответа API без кода и показывает, что не совпало. Начните с учебного примера, затем подставьте свои обезличенные данные. Free работает на Windows и Linux без ограничения срока.

Скачать FreeКак получить и запустить приложение

Скачивание без регистрации и почты, архив готов за пару минут. Состав бесплатной версии опубликован на странице тарифов.

Документация

Статья 720 ГК РФ: приёмка работы заказчиком

Начните с примера по ссылкам и сопоставьте результат с требованием своей проверки.

Можно спросить человека

Поможем с первой проверкой

Расскажите, что хотите проверить или на каком шаге остановились. Поможем запустить Checkcraft, подобрать пример и разобраться с первым прогоном. Можно написать до скачивания.

Telegram-группа открытая: не публикуйте пароли, токены и конфиденциальные рабочие данные. Для первого вопроса достаточно описания задачи.

Можно написать напрямую support@checkcraft.ru

Без регистрации. Ответим по email. Это обращение в поддержку, а не подписка на рассылку.