Документация API · версия 1

Подключение AuthGuard

Отправьте email до создания учётной записи. API определит почтового провайдера домена по MX-записям и вернёт результат, который можно применить в логике регистрации.

Получить API-ключ Открыть OpenAPI

Быстрый старт

1. Выпустите ключ

Создайте ключ в личном кабинете. Полное значение показывается один раз.

2. Сохраните на сервере

Добавьте ключ в переменную AUTHGUARD_API_KEY и не отправляйте его во фронтенд.

3. Выполните запрос

Передайте ключ как Bearer-токен и email пользователя в JSON.

API-ключ должен оставаться на сервере. Если вызвать AuthGuard из браузера или мобильного приложения, ключ сможет увидеть пользователь.

Проверка email-домена

POST

https://api.authguard.ru/v1/check/email

Пример cURL

curl -X POST "https://api.authguard.ru/v1/check/email" \
  -H "Authorization: Bearer $AUTHGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"user@company.ru"}'

Пример для Node.js

const response = await fetch(
  "https://api.authguard.ru/v1/check/email",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.AUTHGUARD_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ email: "user@company.ru" }),
  },
);

const result = await response.json();

if (!response.ok) {
  throw new Error(result.message ?? "AuthGuard request failed");
}

if (!result.can_register) {
  // Не создавайте учётную запись автоматически.
}

Параметры запроса

Параметр	Где	Обязательный	Описание
`Authorization`	Заголовок	Да	`Bearer ВАШ_КЛЮЧ`
`Content-Type`	Заголовок	Да	`application/json`
`email`	JSON	Да	Адрес с доменом, например `user@company.ru`

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

HTTP 200 означает, что проверка выполнена. Решение о регистрации находится в поле can_register, а не в самом HTTP-статусе.

{
  "email_domain": "company.ru",
  "allowed": false,
  "can_register": false,
  "decision": "block",
  "risk_level": "high",
  "provider": "Google Workspace",
  "reason_code": "foreign_mail_provider",
  "matched_rule": null,
  "evidence": {
    "mx": ["aspmx.l.google.com"]
  },
  "meta": {
    "api_key_name": "Основной сайт",
    "requests_today": 1,
    "requests_remaining": 99,
    "daily_limit": 100
  }
}

Поле	Тип	Что означает
`can_register`	boolean	Можно ли автоматически продолжить регистрацию.
`decision`	string	`allow`, `block` или `manual_review`.
`risk_level`	string	Технический уровень риска: `low`, `medium` или `high`.
`provider`	string \| null	Распознанный почтовый провайдер.
`reason_code`	string	Стабильный код причины для программной обработки.
`evidence.mx`	string[]	MX-хосты, найденные во время проверки.
`meta`	object	Название ключа, использование и остаток суточного лимита.

Основные коды причины

known_russian_provider

Распознан российский почтовый провайдер.

foreign_mail_provider

Распознан иностранный почтовый провайдер.

unknown_mail_provider

MX-записи найдены, но провайдер не распознан.

mx_lookup_failed

MX-записи получить не удалось.

Ошибки

HTTP	Код	Что делать
400	`invalid_json`, `invalid_request`, `invalid_email`	Проверьте JSON и значение `email`.
401	`unauthorized`	Проверьте Bearer-токен и убедитесь, что ключ не отозван.
402	`insufficient_balance`	Пополните баланс в личном кабинете.
429	`daily_limit_reached`	Дождитесь обновления лимита или обратитесь в поддержку.
500	`internal_error`	Повторите запрос позже. Если ошибка сохраняется, напишите в поддержку.

Для инструментов и ИИ-агентов

Используйте OpenAPI как источник схемы запросов и ответов. Файл llms.txtсодержит краткое описание продукта и канонические ссылки. Не передавайте API-ключ агенту, которому не доверяете выполнение серверных запросов.

openapi.json llms.txt

AuthGuard выполняет техническую проверку признаков использования иностранных почтовых сервисов и помогает снизить риск нарушения требований к авторизации. Результат API не является юридическим заключением. Подробности приведены в регламенте проверки.