API Response Documentation

В этом разделе описано, какие ответы возвращает API SharkEyes. Ответ может содержать как успешный результат проверки, так и сообщение о блокировке или ошибке. Формат зависит от настроек защиты и типа запроса.

Успешные ответы

При успешной проверке API возвращает статус allowed (разрешено) или ok.

Allowed


{
  "status": "allowed",
  "ray_id": "b7f8d9a1-23c4-4c8e-99af-6c2c8f07e2f1",
  "prediction": "human"
}

Пример (JS-проверка)


{
  "status": "ok",
  "js_succes": true
}

Пример (валидный токен)


{
  "status": "ok",
  "valid": true,
  "reason": null
}

Ответ при блокировке

Если запрос определён как подозрительный или нарушает правила, API возвращает статус blocked.

Пример


{
  "status": "blocked",
  "ray_id": "d3a21c7e-7b42-46a9-83d3-9ef4a85c7f92",
  "reason": "enable rule for suspicious_user_agent"
}

Ошибочные ответы

Ошибки могут возвращаться в двух видах:

IP mismatch

IP mismatch

JSON-ответ


{
  "status": "error",
  "reason": "no IP detected"
}

Коды состояния

200 OK — успешная проверка.

204 No Content — запрос обработан, контента нет.

400 Bad Request — некорректный запрос (например, отсутствуют обязательные параметры).

401 Unauthorized — неавторизованный доступ.

403 Forbidden — доступ запрещён (несоответствие IP/UA/ISS/AUD, сбой JS-проверки).

405 Method Not Allowed — неправильный HTTP-метод.

429 Too Many Requests — превышен лимит запросов.

500 Internal Server Error — внутренняя ошибка API.

502 Bad Gateway — ошибка соединения.

503 Service Unavailable — сервер временно недоступен (обновление или перегрузка).

504 Gateway Timeout — превышено время ожидания ответа.

Дополнительные примеры ошибок

IP mismatch

IP mismatch

UA mismatch

UA mismatch

ISS mismatch

ISS mismatch

AUD mismatch

AUD mismatch

Browser verification failed

Something went wrong during browser verification. Please try again