API документация

REST API для интеграции языковой проверки в ваши сервисы и автоматические процессы

API документация

Базовый адрес: https://lawcheck-production.up.railway.app

Быстрый старт

  1. Токен OCR (если нужен)

    Для проверки изображений или PDF — во вкладке «Картинка» или «Мульти-скан» выберите провайдера (OpenAI / Google / OCR.space) и сохраните токен.

  2. Сделайте запрос

    Для проверки текста — POST /api/check. Для сайта или списка ссылок — POST /api/batch-check или POST /api/multiscan/run.

  3. Получите отчёт

    Через API — /api/export/txt или /api/export/batch-txt. Из UI — кнопки «Скачать отчёт» и «Word» в карточке результатов.

Endpoints

POST /api/check проверка текста — возвращает нарушения и статистику
POST /api/check-url загружает страницу по URL и проверяет её текст
POST /api/batch-check пакетная проверка списка URL (до 500)
POST /api/deep-check детальный анализ слов: формы, типы, замены
POST /api/images/ocr OCR изображения через выбранного провайдера
POST /api/images/check OCR + языковая проверка за один запрос
POST /api/multiscan/run сканирует сайт или список URL (HTML/PDF/изображения)
GET /api/metrics счётчики событий и ошибок сервиса
GET /api/run-history история последних запусков проверок

Пример запроса

curl -X POST "https://lawcheck-production.up.railway.app/api/check" \
  -H "Content-Type: application/json" \
  -d "{\"text\":\"Пример текста для проверки\"}"

JavaScript (fetch)

const resp = await fetch("https://lawcheck-production.up.railway.app/api/check", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ text: "Пример текста" })
});
const data = await resp.json();
console.log(data);

Экспорт отчётов

  • POST /api/export/txt — TXT-отчёт по одиночной проверке.
  • POST /api/export/docx — Word-отчёт по одиночной проверке.
  • POST /api/export/batch-txt — сводный TXT-отчёт пакетной проверки.
  • POST /api/export/batch-docx — Word-отчёт пакетной проверки.
  • POST /api/export/multiscan-txt — TXT-отчёт мульти-скана.
  • POST /api/export/multiscan-docx — Word-отчёт мульти-скана.

Рекомендации по использованию

  • Используйте параметр delay_ms при обработке очередей URL, чтобы не перегружать удалённые серверы.
  • Для больших задач явно задавайте max_urls, max_pages и max_resources — без лимитов запрос может выполняться очень долго.
  • Разбивайте большие списки на пакеты по 50–100 URL вместо одного запроса на 500+.

Коды ответов

Код Значение Что делать
200 Успешно Обработать результат
400 Некорректный запрос Проверить поля/формат данных
401 Нет токена Сохранить token для OCR-провайдера
429 Слишком много запросов Увеличить delay и уменьшить параллельность
500 Ошибка сервера Повторить запрос и проверить входные данные

Сервис бесплатный

API открыт без ключей авторизации. Если сервис полезен в работе — будем рады поддержке.