API Reference
Complete email checker API reference. Endpoints, parameters, response codes for email verification and validation.
EmailVerify API - это RESTful-сервис, предоставляющий мощные возможности верификации email. Все API-запросы должны выполняться через HTTPS.
Базовый URL
https://api.emailverify.ai/v1Аутентификация
Все API-запросы требуют аутентификации с использованием Bearer-токена в заголовке Authorization:
Authorization: Bearer YOUR_API_KEYПолучите API-ключ в панели управления EmailVerify.
Пример
curl -X POST https://api.emailverify.ai/v1/verify \
-H "Authorization: Bearer bv_live_xxx" \
-H "Content-Type: application/json" \
-d '{"email": "test@example.com"}'Лимиты запросов
| Тариф | Запросов/Час | Запросов/День |
|---|---|---|
| Free | 100 | 1,000 |
| Starter | 1,000 | 10,000 |
| Professional | 10,000 | 100,000 |
| Enterprise | Индивидуально | Индивидуально |
Информация о лимитах включена в заголовки ответа:
| Заголовок | Описание |
|---|---|
X-RateLimit-Limit | Максимальное количество разрешённых запросов |
X-RateLimit-Remaining | Оставшееся количество запросов в текущем окне |
X-RateLimit-Reset | Unix-время сброса лимита |
При превышении лимита вы получите ответ 429 Too Many Requests:
{
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Rate limit exceeded. Please try again later.",
"retry_after": 3600
}
}Эндпоинты
Верификация одного email
Проверка одного email-адреса с детальными результатами.
POST /verifyЗапрос
{
"email": "user@example.com",
"smtp_check": true,
"timeout": 5000
}Параметры
| Параметр | Тип | Обязателен | По умолчанию | Описание |
|---|---|---|---|---|
email | string | Да | - | Email-адрес для проверки |
smtp_check | boolean | Нет | true | Выполнять SMTP-проверку почтового ящика |
timeout | integer | Нет | 5000 | Таймаут запроса в миллисекундах (макс: 30000) |
Ответ
{
"email": "user@example.com",
"status": "valid",
"result": {
"deliverable": true,
"valid_format": true,
"valid_domain": true,
"valid_mx": true,
"disposable": false,
"role": false,
"catchall": false,
"free": false,
"smtp_valid": true
},
"score": 0.95,
"reason": null,
"credits_used": 1
}Поля ответа
| Поле | Тип | Описание |
|---|---|---|
email | string | Проверенный email-адрес |
status | string | Статус верификации: valid, invalid, unknown, accept_all |
result | object | Детальные результаты верификации |
score | number | Оценка уверенности (0.0 - 1.0) |
reason | string | Причина статуса invalid/unknown (может быть null) |
credits_used | integer | Количество использованных кредитов |
Поля объекта result
| Поле | Тип | Описание |
|---|---|---|
deliverable | boolean | Может ли email получать сообщения |
valid_format | boolean | Корректен ли синтаксис email |
valid_domain | boolean | Существует ли домен |
valid_mx | boolean | Есть ли у домена MX-записи |
disposable | boolean | Является ли email одноразовым сервисом |
role | boolean | Является ли email ролевым (info@, support@) |
catchall | boolean | Принимает ли домен все письма |
free | boolean | Является ли email от бесплатного провайдера |
smtp_valid | boolean | Прошла ли SMTP-верификация |
Пакетная верификация email
Отправка нескольких email-адресов для проверки. Возвращает ID задания для отслеживания прогресса.
POST /verify/bulkЗапрос
{
"emails": [
"user1@example.com",
"user2@example.com",
"user3@example.com"
],
"smtp_check": true,
"webhook_url": "https://your-app.com/webhooks/emailverify"
}Параметры
| Параметр | Тип | Обязателен | По умолчанию | Описание |
|---|---|---|---|---|
emails | array | Да | - | Массив email-адресов (макс: 10,000) |
smtp_check | boolean | Нет | true | Выполнять SMTP-верификацию |
webhook_url | string | Нет | - | URL для уведомления о завершении |
Ответ
{
"job_id": "job_abc123xyz",
"status": "processing",
"total": 3,
"processed": 0,
"valid": 0,
"invalid": 0,
"unknown": 0,
"credits_used": 3,
"created_at": "2025-01-15T10:30:00Z"
}Получение статуса пакетного задания
Проверка статуса задания пакетной верификации.
GET /verify/bulk/{job_id}Ответ (В процессе)
{
"job_id": "job_abc123xyz",
"status": "processing",
"total": 1000,
"processed": 450,
"valid": 380,
"invalid": 50,
"unknown": 20,
"progress_percent": 45,
"created_at": "2025-01-15T10:30:00Z"
}Ответ (Завершено)
{
"job_id": "job_abc123xyz",
"status": "completed",
"total": 1000,
"processed": 1000,
"valid": 850,
"invalid": 100,
"unknown": 50,
"progress_percent": 100,
"created_at": "2025-01-15T10:30:00Z",
"completed_at": "2025-01-15T10:35:00Z"
}Значения статуса задания
| Статус | Описание |
|---|---|
pending | Задание в очереди |
processing | Задание обрабатывается |
completed | Задание успешно завершено |
failed | Задание завершилось с ошибкой (см. поле error) |
Получение результатов пакетного задания
Получение результатов верификации для завершённого пакетного задания.
GET /verify/bulk/{job_id}/resultsПараметры запроса
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
limit | integer | 100 | Результатов на страницу (макс: 1000) |
offset | integer | 0 | Начальная позиция |
status | string | - | Фильтр по статусу: valid, invalid, unknown |
Ответ
{
"job_id": "job_abc123xyz",
"total": 1000,
"limit": 100,
"offset": 0,
"results": [
{
"email": "user1@example.com",
"status": "valid",
"result": {
"deliverable": true,
"disposable": false,
"role": false
},
"score": 0.95
},
{
"email": "user2@example.com",
"status": "invalid",
"result": {
"deliverable": false,
"reason": "mailbox_not_found"
},
"score": 0.10
}
]
}Проверка кредитов
Получение текущего баланса кредитов и информации об использовании.
GET /creditsОтвет
{
"available": 9500,
"used": 500,
"total": 10000,
"plan": "Professional",
"resets_at": "2025-02-01T00:00:00Z",
"rate_limit": {
"requests_per_hour": 10000,
"remaining": 9850
}
}Вебхуки
Создание вебхука
POST /webhooks{
"url": "https://your-app.com/webhooks/emailverify",
"events": ["verification.completed", "bulk.completed"],
"secret": "your-webhook-secret"
}Список вебхуков
GET /webhooksУдаление вебхука
DELETE /webhooks/{webhook_id}События вебхуков
| Событие | Описание |
|---|---|
verification.completed | Верификация одного email завершена |
bulk.completed | Пакетное задание завершено |
bulk.failed | Пакетное задание завершилось с ошибкой |
credits.low | Кредиты ниже порогового значения |
Полезная нагрузка вебхука
{
"event": "bulk.completed",
"timestamp": "2025-01-15T10:35:00Z",
"data": {
"job_id": "job_abc123xyz",
"status": "completed",
"total": 1000,
"valid": 850,
"invalid": 100,
"unknown": 50
},
"signature": "sha256=..."
}Статусы верификации
| Статус | Значение | Рекомендуемое действие |
|---|---|---|
valid | Email существует и может получать сообщения | Безопасно отправлять |
invalid | Email не существует или не может получать | Удалить из списка |
unknown | Не удалось определить валидность | Повторить позже или действовать с осторожностью |
accept_all | Домен принимает все письма (catch-all) | Отслеживать возвраты |
Ответы об ошибках
Все ошибки следуют единому формату:
{
"error": {
"code": "ERROR_CODE",
"message": "Human-readable error message",
"details": "Additional context (optional)"
}
}HTTP-коды статуса
| Код | Описание |
|---|---|
200 | Успех |
400 | Неверный запрос - Некорректные параметры |
401 | Не авторизован - Неверный или отсутствующий API-ключ |
403 | Запрещено - Недостаточно прав |
404 | Не найдено - Ресурс не существует |
429 | Слишком много запросов - Превышен лимит |
500 | Внутренняя ошибка сервера |
503 | Сервис недоступен |
Коды ошибок
| Код | HTTP-статус | Описание |
|---|---|---|
INVALID_API_KEY | 401 | API-ключ неверен или отсутствует |
RATE_LIMIT_EXCEEDED | 429 | Слишком много запросов |
INSUFFICIENT_CREDITS | 403 | Недостаточно кредитов |
INVALID_EMAIL | 400 | Формат email некорректен |
INVALID_REQUEST | 400 | Тело запроса некорректно |
JOB_NOT_FOUND | 404 | ID пакетного задания не найден |
TIMEOUT | 504 | Таймаут верификации |
Лучшие практики
1. Используйте переменные окружения
Никогда не храните API-ключи в коде:
// Правильно
const apiKey = process.env.EMAILVERIFY_API_KEY;
// Неправильно - не делайте так
const apiKey = 'bv_live_xxx';2. Обрабатывайте лимиты запросов
Реализуйте экспоненциальную задержку:
async function verifyWithRetry(email, maxRetries = 3) {
for (let i = 0; i < maxRetries; i++) {
try {
return await verify(email);
} catch (error) {
if (error.code === 'RATE_LIMIT_EXCEEDED') {
await sleep(Math.pow(2, i) * 1000);
continue;
}
throw error;
}
}
}3. Используйте пакетную обработку для множества email
Для проверки более 10 email используйте пакетный эндпоинт:
// Правильно - один API-вызов
const job = await client.verifyBulk(emails);
// Неправильно - много отдельных вызовов
for (const email of emails) {
await client.verify(email);
}4. Используйте вебхуки для пакетных заданий
Не опрашивайте постоянно; используйте вебхуки:
// Отправка с вебхуком
const job = await client.verifyBulk(emails, {
webhookUrl: 'https://your-app.com/webhook',
});SDK
Используйте наши официальные SDK для упрощения интеграции: