Войти

ShieldAI REST API

Встройте проверку в Telegram-бота, почтовый фильтр или расширение браузера. Все ответы — JSON. Базовый адрес: https://shield-ai.kiri.kz/api/v1/

Авторизация

Без токена API работает с ограничением частоты. С токеном проверки сохраняются в вашу историю. Токен выдаётся в личном кабинете или по запросу (в поле username передаётся email):

curl -X POST https://shield-ai.kiri.kz/api/v1/auth/token/ -d "username=you@mail.kz&password=ПАРОЛЬ"
# {"token": "9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b"}

curl -H "Authorization: Token <токен>" https://shield-ai.kiri.kz/api/v1/me/

Лимиты: без токена 60 запросов в минуту, с токеном 240; проверки — 30 в минуту. При превышении — ответ 429.

Методы

POST/api/v1/check/токен необязателен

Проверка данных. type: url, email, phone, text, qr, screenshot или auto. Для email можно передать текст письма в details. deep: true — глубокий анализ сайта.

curl -X POST https://shield-ai.kiri.kz/api/v1/check/ -H "Content-Type: application/json" \
  -d '{"type": "url", "value": "http://paypa1.com/login", "deep": false}'
{
  "uid": "7c2f1572-a621-4bb3-af1e-8e5335615014",
  "type": "url",
  "score": 100,
  "verdict": "dangerous",
  "findings": [{"level": "high", "title": "Подделка под «paypal»", "text": "..."}],
  "ml_probability": 0.99,
  "ml_explanation": [{"feature": "typosquat", "label": "Тайпсквоттинг", "contribution": 2.3}],
  "result_url": "https://shield-ai.kiri.kz/check/7c2f1572-.../"
}
POST/api/v1/check/bulk/токен необязателен

Быстрая проверка до 20 значений за раз, тип определяется автоматически, без сохранения.

{"items": ["https://kaspi.kz", "kaspi.security@gmail.com", "+7 701 234-56-78"]}
GET/api/v1/checks/нужен токен

История ваших проверок с постраничным выводом. Фильтры: ?verdict=dangerous, ?type=url.

GET/api/v1/checks/{uid}/по ссылке

Полный отчёт по идентификатору проверки.

POSTGET/api/v1/reports/POST — без токена, GET — с токеном

Жалоба на мошенничество. После подтверждения модератором значение попадает в чёрный список.

{"type": "url", "value": "http://fake-bank.top", "description": "Пришло в СМС"}
GET/api/v1/blacklist/check/?kind=domain&value=…

Проверка по чёрному списку. kind: domain, email или phone.

GET/api/v1/stats/ · /api/v1/model/ · /api/v1/health/

Аналитика платформы (как на странице «Аналитика»), метрики и веса ML-модели, статус сервиса для мониторинга.

Пример на Python

import requests

API = "https://shield-ai.kiri.kz/api/v1"
headers = {"Authorization": "Token <ваш токен>"}

r = requests.post(f"{API}/check/", json={"type": "auto", "value": "http://paypa1.com/login"}, headers=headers)
report = r.json()
if report["verdict"] == "dangerous":
    print("Опасно:", report["score"], report["result_url"])

Если открыть любой метод в браузере, появится интерактивная страница Django REST Framework, например /api/v1/stats/.