Developer API
EmailDeliverabilityReport API является интерфейсом для получения актуальной статистики и позволяет получить прямой доступ к нашим данным в центральной базе данных по доставляемости электронной почты, репутации почтового сервера и многому другому.
Наша база данных регулярно обновляется, поэтому ты всегда можешь получить последние данные через API.
Что ты можешь сделать с нашим API
Хочешь построить собственное приложение на основе маркетинговой статистики электронной почты, доставляемости электронной почты или репутации отправителя и нуждаешься в актуальных данных?
Или ты хочешь знать, как меняется доставляемость электронной почты в различных индустриях или при разных провайдеров электронной почты для создания тематических исследований, статистики или диаграмм?
Может быть, ты являешься оператором услуги почтового маркетинга, которую мы тестируем на доставляемость и репутацию, и хочешь быть в курсе того, как твоя инфраструктура напрямую сравнивается с конкуренцией?
Используй наш высокодоступный интерфейс, чтобы получить мгновенный доступ к данным, которые мы собираем с помощью проведения тщательного тестирования. В настоящее время мы оцениваем более 100.000 электронных писем ежемесячно, собирая данные о доставляемости электронной почты и многое другое.
Как ты можешь использовать наш API
Наша текущая версия API 1.0. Для отправки запросов к интерфейсу необходимо использовать следующий SSL защищенный URL:
https://api.emaildeliverabilityreport.com/v1/request?api_key=YOUR_API_KEY
Ты получишь персональный ключ к API после того, как твоя заявка на использование нашего API будет принята. Ключ состоит из 32 символов и должен храниться в надежном месте.
На каждый запрос будет даваться ответ с JSON-строкой. В случае успеха данные будут отправлены вместе с ответом. В случае ошибки дается код ошибки.
Для специализации запроса к URL должны быть добавлены дополнительные параметры, наиболее важным параметром является &action=. Все запросы должны иметь параметр «action».
Следующие действия поддерживаются в текущей версии API:
Действие | Описание |
---|---|
&action=get_providers | Получи всех провайдеров почтового маркетинга, которые в настоящее время есть в нашей базе данных. |
Обязательные параметры |
|
Никаких |
|
Дополнительные параметры |
|
&id=[1|2|...] | Идентификатор провайдера, чтобы сузить запрос. |
Пример запроса
/v1/request?api_key=***&action=get_providers
Результат (PHP)
Array
(
[0] => Array
(
[id] => 1
[name] => GetResponse
[provider_score] => 92
[deliverability_score] => 93
[reputation_score] => 87
)
[1] => ...
Действие | Описание |
---|---|
&action=get_provider_mailservers | Получить все известные нам почтовые сервера провайдера. |
Обязательные параметры |
|
&id=[1|2|...] | Идентификатор провайдера для сужения запроса. Ты получаешь ID, если запрашиваешь всех провайдеров с действием get_providers. |
Дополнительные параметры |
|
Никаких |
|
Пример запроса
/v1/request?api_key=***&action=get_provider_mailservers&id=1
Результат (PHP)
Array
(
[0] => Array
(
[provider_id] => 1
[hostname] => mta-15.gamma.getresponse-mail.com
[ipv4] => 104.160.65.15
[ipv6] =>
[on_blacklists] => 0
)
[1] => Array
(
[provider_id] => 1
[hostname] => mta-1.delta.getresponse-mail.com
[ipv4] => 104.160.67.128
[ipv6] =>
[on_blacklists] => 0
)
[2] => ...
Действие | Описание |
---|---|
&action=get_stats | Получить всю статистику отправки электронной почты для провайдера. Среди прочего, временной период для статистики может быть ограничен дополнительными параметрами. |
Обязательные параметры |
|
&provider_id=[1|2|...] | Идентификатор провайдера. Ты получаешь ID, если отображаешь всех провайдеров с действием get_providers. |
Дополнительные параметры |
|
&email_service_id=[1|2|...] | Идентификатор провайдера электронной почты. Получить идентификатор можно, отобразив всех провайдеров электронной почты с помощью действия get_email_services. |
&category_id=[1|2|...] | Идентификатор категории. Ты получаешь ID, если отображаешь все категории с действием get_categories. |
&year=[2019|2020...] | Четырехзначное число, обозначающее год. |
&month=[1|2|3] | Номер от одной до двух цифр, обозначающий месяц. |
Пример запроса
/v1/request?api_key=***&action=get_stats&provider_id=1&year=2020
Результат (PHP)
Array
(
[0] => Array
(
[provider_id] => 1
[email_service_id] => 1
[category_id] => 1
[year] => 2020
[month] => 1
[volume] => 88
[inbox] => 59
[spam] => 28
[lost] => 1
)
[1] => Array
(
[provider_id] => 1
[email_service_id] => 2
[category_id] => 1
[year] => 2020
[month] => 1
[volume] => 60
[inbox] => 41
[spam] => 18
[lost] => 1
)
[2] => ...
Действие | Описание |
---|---|
&action=get_categories | Получи все категории и некоторую дополнительную информацию. |
Обязательные параметры |
|
Никаких |
|
Дополнительные параметры |
|
&id=[1|2|...] | Идентификатор категории для сужения запроса. |
Пример запроса
/v1/request?api_key=***&action=get_categories
Результат (PHP)
Array
(
[0] => Array
(
[id] => 1
[name] => Clothing
)
[1] => Array
(
[id] => 2
[name] => Elektronics
)
[2] => ...
Действие | Описание |
---|---|
&action=get_email_services | Получи всех провайдеров электронной почты и некоторую дополнительную информацию. |
Обязательные параметры |
|
Никаких |
|
Дополнительные параметры |
|
&id=[1|2|...] | Идентификатор провайдера электронной почты, чтобы сузить запрос. |
Пример запроса
/v1/request?api_key=***&action=get_email_services
Результат (PHP)
Array
(
[0] => Array
(
[id] => 1
[name] => Gmail
)
[1] => Array
(
[id] => 2
[name] => Outlook Mail
)
[2] => ...
Подать заявление на API
Если ты хочешь использовать наш API, тебе нужно подать заявку. Мы хотим быть уверенными в том, что мы работаем только с правильными бизнес-партнерами и в то же время являемся правильным партнером для твоего проекта.
Как работает заявление
4 шага отделяют тебя от использования нашего API:
- Ты подаешь заявление через форму заявки и присылаешь нам некоторую информацию о своем проекте и назначении нашего API.
- В течение 7 дней мы рассмотрим твою заявку и проинформируем тебя о нашем решении по электронной почте.
- Если твоя заявка будет принята, мы вышлем тебе по электронной почте ссылку PayPal, чтобы установить ежемесячную подписку с PayPal по выбранному тобой тарифу.
- После того, как мы получим первый платеж, мы создадим для тебя аккаунт для нашего онлайн API интерфейса и отправим тебе по электронной почте твои регистрационные данные, чтобы ты мог использовать API.
Заявление не является обязательным к исполнению, и мы не можем гарантировать, что мы примем твое заявление. Тем не менее, в любом случае мы свяжемся с тобой, чтобы ответить на заявку.
Заявление
В форме ниже выбери один из доступных тарифов и предоставь нам некоторую информацию о назначении нашего API, чтобы мы знали, как и в какой степени ты хочешь использовать наш API.
После получения заявки мы проверим, подходит ли наш API для твоего проекта и хотим ли мы сотрудничать с тобой. В течение 7 дней мы вернемся к тебе с нашим решением.
За хорошее сотрудничество для обеих сторон.