НОРМОСКАН Документация
API v1JSON, PDF и уточнения

JSON, PDF и уточнения

Обновлено 8 октября 2026

Получить результат после done

bash
curl --fail-with-body "$NK_BASE/runs/$RUN_ID/findings" \
  -H "Authorization: Bearer $NK_KEY" --output findings.json
curl --fail-with-body "$NK_BASE/runs/$RUN_ID/report.pdf" \
  -H "Authorization: Bearer $NK_KEY" --output report.pdf
curl --fail-with-body "$NK_BASE/runs/$RUN_ID/report" \
  -H "Authorization: Bearer $NK_KEY" --output report.md
Поле ответа /findingsЧто означает
findingsМассив замечаний. Для записи решения используйте finding_id. n обозначает номер замечания в отчёте.
questionsМассив вопросов. Они не входят в counts.total. Старый ответ может не содержать это поле.
counts.totalЧисло замечаний. Другие ключи counts показывают число замечаний каждого уровня важности.
available_sectionsДоступные отчёты по разделам. code содержит код раздела. findings содержит число замечаний. Старый отчёт или другое подключение может не содержать это поле.
parsedtrue означает, что сервер разобрал отчёт на поля. Если parsed равен false, покажите raw_markdown или скачайте /report.
warnings / reference_problemsОграничения проверки и ошибки ссылок. Покажите их специалисту вместе с замечаниями.
feedback_snapshot / feedback_actor / feedbackВерсия результата, автор интеграции и сохранённые решения по замечаниям.
usageРасход обработки. Ноль не означает бесплатную проверку. Стоимость для клиента определяется тарифом.

Пример одного элемента findings

json
{
  "n": 7,
  "finding_id": "16f2c114-4904-4cb3-8a92-b61f5e6a583a",
  "status": "Замечание",
  "importance": "Существенная",
  "section": "ЭОМ",
  "essence": "Расчётная мощность щита различается в двух документах.",
  "evidence_text": "EOM.pdf, стр. 12: 12 кВт; AR.pdf, стр. 4: 15 кВт.",
  "action": "Согласовать нагрузку и исправить связанный документ.",
  "pages": [12, 24],
  "page_refs": [
    {"page": 12, "in_docset": true, "kind": "ЭОМ", "doc_index": 1, "doc_page": 12, "label": "ЭОМ, стр. 12"},
    {"page": 24, "in_docset": true, "kind": "АР", "doc_index": 2, "doc_page": 4, "label": "АР, стр. 4"}
  ],
  "sources": []
}

essence содержит суть замечания. evidence_text содержит доказательство и ссылки. action содержит предлагаемое действие. section обозначает раздел документации. album и stage могут указывать том и стадию.

topic обозначает тематическую группу, а не раздел документации.

Для подписи страницы используйте page_refs[].label. doc_page обозначает страницу внутри документа. page обозначает сквозную страницу комплекта. Если page_refs пуст, используйте evidence_text. status внутри замечания отличается от status проверки.

Набор текстовых значений status и importance может расширяться.