Версия API и термины
Обновлено 8 октября 2026
Версия API: v1. JSON использует UTF-8. Временные метки используют ISO 8601 с часовым поясом, обычно UTC. Пропускайте неизвестные поля. Порядок ключей JSON не имеет значения.
Получите поддерживаемые версии через GET /version. Несовместимая версия получает новый префикс API.
| Термин | Простое объяснение |
|---|---|
| run_id | Идентификатор одной принятой проверки. |
| bundle_id | Идентификатор проекта, который объединяет проверки. |
| finding_id | Идентификатор замечания для записи решения. Не заменяйте его номером n. |
| feedback_snapshot | Версия опубликованного результата, к которой относится решение. |
| Idempotency-Key | Метка отправки комплекта, защищающая от повторного запуска при потере ответа. |
| request_key | Метка отправки решения по замечанию. Она защищает от повторной записи при потере ответа. |
| section | Раздел документации, например ЭОМ или СС. theme обозначает более широкую тематическую группу. |
| вебхук | HTTP-уведомление от НОРМОСКАНА на ваш сервер. |
| комплект | Документы, отправленные вместе на одну проверку. |
| подключение | Доступ организации к API с её лимитами и возможностями. |
| context | Справочный документ. Он служит контекстом для проверки. |
| review | Документ, который нужно проверить. |
Откройте «Справочник методов» для параметров и ответов. Все пути отсчитываются от /api/v1. Для Postman, Insomnia или генератора клиента скачайте OpenAPI JSON. Описания в OpenAPI также даны на русском языке.