Справочник разработчика

Руководство по интеграции

Читать справочник по API в простом Markdown →

Войдите через Google или с помощью кода подтверждения по email, затем откройте Панель управления → Ключ API. Скопируйте ключ, когда он отображается: в нашей базе данных сохраняется только его хеш SHA-256. Существующие пользователи могут привязать устаревший ключ с помощью его приватного токена управления.

Серверная проверка

POST /api/v1/check
Content-Type: application/json
x-api-key: YOUR_API_KEY

{
  "text": "Can you quote this project?",
  "email": "[email protected]"
}

Ответы включают verdict (allow, block, review), score, reason, engine (jev или rules), model (версия провайдера по результатам ИИ), execution_time_ms и quota_remaining. Оценки от правил являются эвристическими приближениями. Уверенность присутствует только для Jev. Рассматривайте review как неопределенность, а не автоматическую блокировку.

Коды состояния: 400 (недопустимый ввод), 401 (отсутствует ключ), 403 (недопустимый ключ), 429 (квота исчерпана), 503 (сервис недоступен). Максимальный размер сообщения: 10 000 символов. Необязательно business_context (до 1 000 символов) описывает желаемые запросы; не включайте секреты. При сбое провайдера происходит возврат к локальным эвристическим правилам.

Журналы обнаружения и отчёты о выполнении

Панель управления → Журналы обнаружения показывает ваши проверки с аутентификацией за последние 7 дней. Выберите Uncertain — review в фильтре вердиктов, чтобы изучить неопределённые результаты. Это запись проверок и заявленных действий, а не почтовый ящик или очередь для хранения или восстановления сообщений. Необязательные site (URL-адрес HTTP/HTTPS; сохраняется только его имя хоста) и form_id (до 80 букв, цифр, знаков подчёркивания, двоеточий или дефисов) идентифицируют вашу интеграцию. Текст сообщения по умолчанию отключён и может быть включён в вашей учётной записи. Проверки в публичном демо исключены.

Успешное логирование добавляет check_id и report_token к ответу проверки; logging_status имеет значение saved или unavailable. Сбои логирования не меняют классификацию. Храните токен отчёта на своём сервере. После применения вашего решения отправьте POST на /api/v1/report с тем же API-ключом:

{
  "check_id": "CHECK_UUID",
  "report_token": "TOKEN_FROM_CHECK",
  "action": "allowed",
  "reason": "verdict"
}

Допустимые значения action: allowed, blocked, или error_allowed. Последний плагин WordPress сообщает свое действие автоматически. Только наблюдение сообщает allowed с причиной observe. Отсутствующий или неудачный отчет отображается как Not reported; действие allowed не подтверждает доставку email.

Для пользовательской интеграции с API наблюдение — это политика в вашем собственном серверном коде: вызовите конечную точку проверки, зафиксируйте вердикт, продолжите свой обычный процесс отправки и сообщите о применённом действии. API проверки не включает и не отключает блокировку в вашей форме автоматически. Наблюдение всё равно обрабатывает содержимое сообщения и расходует квоту обнаружения.

Необязательный помощник браузера

<form data-formshield> ... </form>
<script src="https://jevshield.com/shield.js" data-key="YOUR_API_KEY"></script>

Помощник проверяет только явно помеченные формы, отправляет поля сообщения, электронной почты и имени и разрешает отправку после сетевого сбоя или 6-секундного тайм-аута. Его можно обойти, и он раскрывает ключ API посетителям. Используйте серверные проверки для принудительного применения и сохранения ключа в тайне. Протестируйте плагины AJAX-форм, прежде чем включать его.

Маршрутизация лидов

Откройте Dashboard → Routing, чтобы описать ваш бизнес и при необходимости сохранить webhook или URL бронирования. Контекст аккаунта используется, когда запрос не предоставляет собственный business_context. Результаты с высоким намерением могут отправлять данные запроса и контактов на настроенный вами webhook; используйте контролируемое вами назначение и отразите эту обработку в вашем уведомлении о конфиденциальности.

Настроенный URL бронирования возвращается как meeting_url для результатов с высоким намерением. Ваша интеграция решает, отображать его или переходить по нему. Плагин WordPress и пользовательские интеграции могут вести себя по-разному; проверьте полный путь посетителя. Тест вебхука использует синтетический запрос и подтверждает HTTP-ответ получателя, а не доставку по цепочке.

Откройте настройки маршрутизации →

WordPress

Скачайте ZIP-архив последнего плагина JevShield, установите его в WordPress, затем откройте Настройки → JevShield AI и введите свой API-ключ и полный HTTPS-эндпоинт /api/v1/check. В разделе Режим защиты выберите Только наблюдение, чтобы классифицировать и логировать без блокировки этим плагином. Новые установки начинают в режиме Только наблюдение; существующие настроенные установки сохраняют блокировку, пока вы не измените режим. Наблюдение использует квоту и передает поля отправки для обработки, поэтому опишите это в своем уведомлении о конфиденциальности. Проверьте фактическую доставку вашей формы, прежде чем переключаться на Блокировать спам с высокой уверенностью.

JevShield также указан в Каталог плагинов WordPress.org. Релизы в каталоге могут появиться позже, чем ZIP здесь; если Режим защиты отсутствует, обновитесь, используя последний ZIP. Отдельный устаревший плагин FormShield сохраняет свои существующие настройки и путь обновления. Его настройки бизнес-контекста и переопределения точного email не были добавлены в плагин JevShield. API по-прежнему принимает business_context для пользовательских интеграций.