Email-валидатор

Проверить книгу

Чтобы отправить книгу на проверку, отправляется POST-запрос по ссылке:

https://mailer-api.i.bizml.ru/verifier-service/send-list-to-verify

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

id Идентификатор книги, которую нужно проверить

Пример запроса:

{
   "id":89165888
}

Параметр ответа:

result Результат проверки: завершена — true, не завершена — false

Обратите внимание, что запустить несколько проверок на одну и ту же книгу одновременно нельзя. Нужно дождаться окончания первой проверки. Проверить прогресс проверки можно методом Получить прогресс проверки книги.

Если вы отправляете книгу на повторную проверку, в нее должны быть добавлены новые адреса. Проверка осуществляется только по книге, на которую не было рассылок. Также обращайте внимание на срок действия вашего текущего плана и количество доступных проверок. 

Пример ответа:

{
    "result": true
}

Для просмотра результата проверки используйте метод Получить результат проверки книги.

 

Получить прогресс проверки книги

Чтобы получить прогресс проверки адресной книги, отправляется GET-запрос по ссылке:

https://mailer-api.i.bizml.ru/verifier-service/get-progress/?id={id} 

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

id

Идентификатор книги, которая проверяется

Параметры ответа:

result Результат проверки: завершена — true, не завершена — false
data Данные о проверках
total Всего проверок
processed Сколько проверок завершены

Пример ответа:

{
    "result": true,
    "data": {
        "total": 22,
        "processed": 22
    }
}
 

Получить результат проверки книги

Чтобы получить список адресов из книги с результатом проверки, отправляется GET-запрос по ссылке:

https://mailer-api.i.bizml.ru/verifier-service/check/?id={id} 

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

id Идентификатор книги, которую проверили

Обратите внимание, что методы следует использовать попарно: сначала нужно использовать метод «Проверить книгу», затем «Получить результат проверки книги». В противном случае вы получите ответ false.

Параметры ответа:

id Идентификатор книги
address_book_name Название книги
all_email_quantity Количество активных адресов в книге
status

Статус проверки

check_date Дата проверки
data

0 — количество непроверенных адресов (серые);

1 —  количество действительных адресов (зеленые);

2 —  количество неподтвержденных адресов (желтые);

3 — количество недействительных адресов (красные).

is_updated

1 — в книгу были добавлены новые адреса после проверки

0 —  по книге не было проверки

status_text
Статус проверки
email_addresses
Информация об адресах
id 
Идентификатор адреса
email_address
Адрес электронной почты
check_date
Дата проверки
status
Статус проверки
status_text
Текстовое описание статуса
email_addresses_total

Количество проверок в книге

Пример ответа:

{
    "id": 89163337,
    "address_book_name": "Новая адресная книга",
    "all_emails_quantity": 5,
    "status": 1,
    "check_date": "2020-11-19 13:42:11",
    "data": {
        "0": 0, 
"1": 5,
"2": 1,
"3": 0 }, "is_updated": 0, "status_text": "Зелёный", "email_addresses": [ { "id": 10417371353, "email_address": "example1@mail.ru", "check_date": "2020-11-19 13:41:20", "status": 1, "status_text": "Действительный адрес" }, { "id": 10417371352, "email_address": "example2@ukr.net", "check_date": "2020-11-19 13:41:23", "status": 1, "status_text": "Действительный адрес" }, { "id": 10417371349, "email_address": "example3@gmail.com", "check_date": "2020-11-19 13:41:20", "status": 1, "status_text": "Действительный адрес" }, { "id": 10417371347, "email_address": "example4@gmail.com", "check_date": "2020-11-19 13:41:21", "status": 1, "status_text": "Действительный адрес" }, { "id": 10417371345, "email_address": "example5@rambler.ru", "check_date": "2020-11-19 13:41:20", "status": 1, "status_text": "Действительный адрес" } ], "email_addresses_total": 5 }

Получить список проверенных книг

Чтобы получить список проверенных адресных книг, отправляется GET-запрос по ссылке:

https://mailer-api.i.bizml.ru/verifier-service/check-list

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

start С какой записи выводить результат; по умолчанию 0. Необязательный параметр
count Количество записей, по умолчанию 10. Необязательный параметр

Параметры ответа:

total
Количество проверенных адресных книг
list Список книг
id Идентификатор книги
address_book_name Название книги
all_emails_quantity Количество активных электронных адресов в книге
status

Статус проверки адресной книги

check_date Дата проверки
data 0 — количество непроверенных адресов (серые);
1 — количество действительных адресов (зеленые);
2 — количество неподтвержденных адресов (желтые);
3 — количество недействительных адресов (красные).
is_updated
1 — в книгу были добавлены новые адреса после проверки
0 — по книге не было проверки
status_text
Статус проверки
is_garbage_in_book
 В книге есть ранее проверенные адреса — true, по книге не было проверки — false

Пример ответа:

{
    "total": 2, 
    "list": [
        {
            "id": 89114118,
            "address_book_name": "Mailing list 1",
            "all_emails_quantity": 20, 
            "status": 1, 
            "check_date": "2020-11-23 14:28:14", 
            "data": {
                "0": 0, 
                "1": 21, 
                "2": 1, 
                "3": 0 
            },
            "is_updated": 0, 
            "status_text": "Зеленый",
            "is_garbage_in_book": false 
        },
        {
            "id": 89163340,
            "address_book_name": "Mailing list 2",
            "all_emails_quantity": 2, 
            "status": 1,
            "check_date": "2020-11-19 13:43:11",
            "data": {
                "0": 0, 
                "1": 2, 
                "2": 0, 
                "3": 0 
            },
            "is_updated": 1, 
            "status_text": "Зелёный, обновлён",
            "is_garbage_in_book": true 
        }
    ]
}

Удалить результат проверки книги

Чтобы удалить результат проверки адресной книги, отправляется POST-запрос по ссылке:

https://mailer-api.i.bizml.ru/verifier-service/delete-list-result

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

id Идентификатор книги для которой нужно удалить результат проверки 

Пример запроса:

{
   "id":89165888
}

В случае успешного запроса сервер вернет ответ:

{
    "result": true
}
 

Проверить адрес

Чтобы проверить один адрес, отправляется POST запрос по ссылке:

https://mailer-api.i.bizml.ru/verifier-service/send-single-to-verify/

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

email Электронный адрес, который нужно проверить

Пример запроса:

{
   "email":"user@example.com"
}

В случае успешного запроса сервер вернет ответ:

{
    "result": true
}

Для просмотра результата проверки используйте метод "Получить результат проверки адреса" (см. ниже).

 

Получить результат проверки адреса

Чтобы получить результат проверки адреса, отправляется GET-запрос по ссылке:

https://mailer-api.i.bizml.ru/verifier-service/get-single-result/?email={email}

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

email Электронный адрес, который проверяли

Обратите внимание, что методы следует использовать попарно: cначала нужно использовать метод «Проверить адрес», затем «Получить результат проверки адреса». В противном случае вы получите ответ false.

Параметры ответа:

result Результат проверки
data Данные проверки
email Адрес электронной почты
checks Данные по проверке
status Статус проверки
valid_format
Если значение 1, то формат адреса правильный (содержит допустимые символы в правильном порядке)
disposbale
Если значение 1, то адрес предоставлен одноразовой службой электронной почты
webmail
Если значение 1, то адрес предоставлен службой электронной почты
gibberish
Если значение 1,  то адрес сгенерирован автоматически
status_text Текстовое описание статуса проверки

Пример ответа:

{
    "result": true,
    "data": {
        "email": "example1@gmail.com",
        "checks": {
            "status": 1,
            "valid_format": 1, 
            "disposable": 0, 
            "webmail": 0,
            "gibberish": 0, 
            "status_text": "Действительный адрес"
        }
}

Удалить результат проверки адреса

Чтобы удалить результат проверки одного адреса, отправляется POST запрос по ссылке:

https://mailer-api.i.bizml.ru/verifier-service/delete-single-result

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

email Электронный адрес для которого нужно удалить результат проверки

Пример запроса:

{
   "email":"user@example.com"
}
В случае успешного запроса сервер вернет ответ:
{
    "result": true
}

Создать отчет проверки адресной книги

Чтобы создать отчет c результатами проверки адресной книги, отправляется POST-запрос по ссылке:

https://mailer-api.i.bizml.ru/verifier-service/make-report

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

id Идентификатор книги, которую проверяли
format

Формат отчета, допустимые значения:

2 — csv;

3 — xls;

4 — xlsx.

По умолчанию 2. Необязательный параметр.

status

С какими статусами должны быть адреса в отчете:

0 — непроверенные;

1 — действительные;

2 — неподтвержденные;

3 — недействительные.

По умолчанию 1. Необязательный параметр

lang Язык отчета. Необязательный параметр

Пример запроса:

{
   "id":89165888,
   "format":2,
   "status":"[1,2,3]",
   "lang":"ru"
}

В случае успешного запроса сервер вернет ответ:

{
 "result": true
}
 

Просмотреть отчет проверки книги

Чтобы просмотреть отчет c результатами проверки адресной книги, отправляется GET-запрос по ссылке:

https://mailer-api.i.bizml.ru/verifier-service/check-report?id={id}

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

id Идентификатор книги, для которой создали отчет
format

Формат отчета, допустимые значения:

2 — csv;

3 — xls;

4 — xlsx.

По умолчанию 2. Необязательный параметр

Обратите внимание, что методы следует использовать последовательно: cначала нужно использовать метод «Создать отчет», затем «Получить отчет проверки» и «Cкачать отчет». В противном случае вы получите ответ false.

Параметры ответа:

id Идентификатор книги
address_book_name Название книги
all_emails_quantity
Количество активных адресов в книге
status Статус проверки
check_date Дата проверки
data Данные по проверке
is_updated
1 —  в книгу были добавлены новые адреса после проверки;
0 — по книге не было проверки.

status_text Текстовое описание статуса
email_addresses Данные по адресам
id Идентификатор адреса
email_address Электронный адрес
check_date Дата проверки
status Статус проверки
status_text Текстовое описание проверки
email_addresses_total
Количетво проверок в книге

Пример ответа:

{
    "id": 89165888,
    "address_book_name": "Новый список 1",
    "all_emails_quantity": 10,
    "status": 3,
    "check_date": "2020-11-23 18:02:36",
    "data": {
        "0": 0,
        "1": 3,
        "2": 1,
        "3": 0
    },
    "is_updated": 0,
    "status_text": "Желтый",
    "email_addresses": [
        {
            "id": 10422192143,
            "email_address": "user@example.com",
            "check_date": "2020-11-23 18:01:35",
            "status": 3,
            "status_text": "Неподтвержденный адрес"
        },
        {
            "id": 10422192131,
            "email_address": "user2@example.com",
            "check_date": "2020-11-23 18:01:35",
            "status": 1,
            "status_text": "Действительный адрес"
        },
        {
            "id": 10422192128,
            "email_address": "user3@example.com",
            "check_date": "2020-11-23 18:01:34",
            "status": 1,
            "status_text": "Действительный адрес"
        },
        {
            "id": 10422192125,
            "email_address": "user4@example.com",
            "check_date": "2020-11-23 18:01:35",
            "status": 1,
            "status_text": "Действительный адрес"
        }
    ],
    "email_addresses_total": 4 
}

Скачать отчет проверки книги

Чтобы скачать отчет c результатами проверки адресной книги, отправляется GET-запрос по ссылке:

https://mailer-api.i.bizml.ru/verifier-service/get-report?id={id}

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

id Идентификатор книги, для которой создали отчет
format

Формат отчета, допустимые значения:

2 — csv;

3 — xls;

4 — xlsx.

По умолчанию 2. Необязательный параметр

В случае успешного запроса получите список адресов и статус проверки каждого в выбранном формате.

Обратите внимание, что после скачивания отчета он будет удален из базы. При повторной попытке получения отчета получите ответ false.