Для разработчиков

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

REST API для автоматической проверки текстов, сайтов и документов на соответствие 168-ФЗ. Интегрируйте проверку в CMS, CRM или CI/CD пайплайн.

Аутентификация

# Передайте API-ключ в заголовке

curl -H "X-API-Key: your_api_key" \

https://168scan.ru/api/v1/usage

API-ключ можно получить в личном кабинете при покупке пакета от 100 000 слов.

Лимиты

Rate limit: 60 запросов в минуту на ключ

Символы: списываются с баланса после каждой успешной проверки

Эндпоинты

POST/api/v1/check-text

Проверка текста на иностранные слова

Тело запроса

{ "text": "Проверяемый текст до 50 000 символов" }

Ответ

{
  "total": 15,
  "allowed": [{ "word": "онлайн", "sources": [...] }],
  "violations": ["кешбэк", "лайфхак"],
  "properNouns": [{ "word": "Яндекс", "label": "организация" }],
  "allowedCount": 12,
  "violationsCount": 2,
  "properNounsCount": 1
}

POST/api/v1/check-url

Проверка сайта по URL

Тело запроса

{ "url": "https://example.com" }

Ответ

{
  "success": true,
  "url": "https://example.com",
  "domain": "example.com",
  "totalWordCount": 42,
  "latinWords": [{ "word": "login", "element": "Кнопка", "context": "...", "translation": "вход" }],
  "cyrillicLoanwords": [{ "word": "кешбэк", "context": "...", "status": "violation" }]
}

GET/api/v1/lookup/:word

Проверка одного слова по словарям РАН

Ответ

{
  "word": "интерфейс",
  "found": true,
  "status": "allowed_dictionary",
  "sources": [{ "dictionary": "Словарь иностранных слов РАН", "article": "..." }]
}

GET/api/v1/usage

Остаток лимита по текущему ключу

Ответ

{
  "wordsRemaining": 487500
}

Коды ошибок

Код	Описание
401	Не передан или невалидный API-ключ
402	Лимит символов исчерпан
422	Некорректные входные данные
429	Превышен rate limit (60 req/min)
500	Внутренняя ошибка сервера
503	Сервер временно недоступен