API Reference

Интегрируйте возможности Ёфикатора с помощью нашего быстрого REST API. Доступно без ключей авторизации.

POST /api/efikate

Основной эндпоинт для обработки текста. Принимает JSON и возвращает обработанный текст вместе с метаданными о произведенных заменах.

Параметры запроса (Body)

Параметр	Тип	Описание
text	string required	Исходный текст для обработки на русском языке. Ограничение: 100,000 символов.
html	boolean optional	Если `true`, замененные слова будут обернуты в тег `<span class="yo-highlight">` для визуальной подсветки на фронтенде. По умолчанию `false`.

Rate Limits (Ограничения)

Для обеспечения стабильности сервиса действует лимит в 100 запросов в минуту с одного IP-адреса. Для enterprise-интеграций свяжитесь с нами.

curl -X POST https://efikator.ru/api/efikate \
  -H "Content-Type: application/json" \
  -d '{"text": "Ежик шел по лесу."}'

import requests

url = "https://efikator.ru/api/efikate"
payload = {
    "text": "Ежик шел по лесу.",
    "html": False
}

response = requests.post(url, json=payload)
print(response.json())

const response = await fetch('https://efikator.ru/api/efikate', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ 
    text: 'Ежик шел по лесу.' 
  })
});

const data = await response.json();
console.log(data);

Response (200 OK)

{
  "success": true,
  "original": "Ежик шел по лесу.",
  "result": "Ёжик шёл по лесу.",
  "meta": {
    "edits_count": 2,
    "processing_time_ms": 1.24
  }
}