MailHandler.ru API
Search…
Introduction
Основная информация
Введение
Авторизация
Возможности API
Подписчики
Списки
Дополнительные поля
Подписчики
Адреса для отправки писем
Добавление адресов
Статистика
Общая статистика
Статистика отказов от рассылок
Статистика ошибок доставки
Транзакционное API
Отправка писем
Контекстные переменные
Трекинг
Отслеживание писем
HTTP-уведомления
Powered By GitBook
Добавление адресов
С помощью API вы можете создавать, редактировать и удалять адреса для отправки ваших писем.
Базовый URL: http://api.mailhandler.ru/senders/​

Получение списка адресов

Отправьте GET запрос на URL http://api.mailhandler.ru/senders/. Запрос не должен содержать параметров.
В результате вы получите ответ в формате JSON со списком созданных вами адресов для отправки.
Bash
Python
Пример получения списка объектов с помощью curl:
curl 'http://api.mailhandler.ru/senders/' \
-X GET \ -H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Secure-Token: <YOUR_TOKEN>'
Пример получения списка объектов на python:
import requests
​
def get_list():
headers = {
'X-Secure-Token': '<YOUR_TOKEN>',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
response = requests.get('http://api.mailhandler.ru/senders/',
json=data,
headers=headers)
print(response.status_code)
В случае успешного выполнения запроса вы получите ответ в формате JSON со статусом 200 OK
{
"count": 1,
"next": null,
"previous": null,
"results": [{
"id": 106,
"full_name": "Иван Петров",
"from_email": "[email protected]",
"reply_to_email": "",
"is_verified": false
}]
}

Создание адреса

Отправьте POST запрос на URL http://api.mailhandler.ru/senders/. Запрос должен содержать следующие параметры:
Название
Описание
Обязателен
Пример
full_name
Полное имя отправителя
Да
Иван Петров
from_email
Адрес Email
Да
reply_to_email
Адрес Email для получения ответов
Нет
В результате успешного создания объекта вы получите ответ в формате JSON с данными созданного объекта:
Название
Описание
Пример
id
Идентификатор объекта
100
full_name
Полное имя отправителя
Иван Петров
from_email
Адрес Email
reply_to_email
Адрес Email для получения ответов
is_verified
Подтвержден адрес или нет, boolean
false
date_created
Дата создания объекта
2017-03-15T10:21:56.854530
Внимание: на адрес, который вы передали в качестве значения параметра from_email будет отправлено письмо с ссылкой для его подтверждения. Чтобы использовать этот адрес для отправки писем, вам необходимо будет перейти по этой ссылке.
Bash
Python
Пример создания объекта с помощью curl:
curl 'http://api.mailhandler.ru/senders/' \
-X POST \ -H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Secure-Token: <YOUR_TOKEN>' \
-d '{"full_name":"Иван Петров", "from_email":"[email protected]"}'
Пример создания объекта на python:
import requests
​
def create():
headers = {
'X-Secure-Token': '<YOUR_TOKEN>',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
data = {
'full_name': 'Иван Петров',
'from_email': '[email protected]'
}
response = requests.post('http://api.mailhandler.ru/senders/',
json=data,
headers=headers)
print(response.status_code)
В случае успешного создания объекта вы получите ответ в формате JSON со статусом 201 Created
{
"id": 106,
"full_name": "Иван Петров",
"from_email": "[email protected]",
"reply_to_email": "",
"is_verified": false
}

Редактирование адреса

Отправьте PUT или PATCH запрос на URL http://api.mailhandler.ru/senders/{sender_id}/, где sender_id - идентификатор нужного вам адреса.
Запрос может содержать следующие параметры:
Название
Описание
Обязателен
Пример
full_name
Полное имя отправителя
Да
Иван Петров
from_email
Адрес Email
Да
reply_to_email
Адрес Email для получения ответов
Нет
В результате успешного создания объекта вы получите ответ в формате JSON с данными отредактированного объекта:
Название
Описание
Пример
id
Идентификатор объекта
100
full_name
Полное имя отправителя
Иван Петров
from_email
Адрес Email
reply_to_email
Адрес Email для получения ответов
is_verified
Подтвержден адрес или нет, boolean
false
date_created
Дата создания объекта
2017-03-15T10:21:56.854530
Bash
Python
Пример редактирования объекта с помощью curl:
curl 'http://api.mailhandler.ru/senders/100/' \
-X PATCH \ -H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Secure-Token: <YOUR_TOKEN>' \
-d '{"from_email":"[email protected]"}'
Пример редактирования объекта на python:
import requests
​
def edit():
headers = {
'X-Secure-Token': '<YOUR_TOKEN>',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
data = {
'from_email': '[email protected]'
}
response = requests.patch('http://api.mailhandler.ru/senders/100/',
json=data,
headers=headers)
print(response.status_code)
В случае успешного изменения объекта вы получите ответ в формате JSON со статусом 200 OK
{
"id": 106,
"full_name": "Иван Петров",
"from_email": "[email protected]",
"reply_to_email": "",
"is_verified": true
}

Получение данных адреса

Отправьте GET запрос на URL http://api.mailhandler.ru/senders/{sender_id}/, где sender_id - идентификатор нужного вам адреса.
Запрос не должен содержать параметров.
В результате успешного запроса вы получите ответ в формате JSON с данными отредактированного объекта:
Название
Описание
Пример
id
Идентификатор объекта
100
full_name
Полное имя отправителя
Иван Петров
from_email
Адрес Email
reply_to_email
Адрес Email для получения ответов
is_verified
Подтвержден адрес или нет, boolean
false
date_created
Дата создания объекта
2017-03-15T10:21:56.854530
Bash
Python
Пример получения данных объекта с помощью curl:
curl 'http://api.mailhandler.ru/senders/100' \
-X GET \ -H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Secure-Token: <YOUR_TOKEN>'
Пример получения данных объекта на python:
import requests
​
def get():
headers = {
'X-Secure-Token': '<YOUR_TOKEN>',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
response = requests.get('http://api.mailhandler.ru/senders/100/',
headers=headers)
print(response.status_code)
В случае успешного получения данных объекта вы получите ответ в формате JSON со статусом 200 OK
{
"id": 106,
"full_name": "Иван Петров",
"from_email": "[email protected]",
"reply_to_email": "",
"is_verified": true
}

Удаление адреса

Отправьте DELETE запрос на URL http://api.mailhandler.ru/senders/{sender_id}/, где sender_id - идентификатор нужного вам адреса.
Запрос не должен содержать параметров.
В результате успешного запроса вы получите ответ со статусом 204 No Content.
Bash
Python
Пример удаления объекта с помощью curl:
curl 'http://api.mailhandler.ru/senders/100' \
-X DELETE \ -H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Secure-Token: <YOUR_TOKEN>'
Пример удаления объекта на python:
import requests
​
def delete():
headers = {
'X-Secure-Token': '<YOUR_TOKEN>',
'Accept': 'application/json',
'Content-Type': 'application/json',
}
response = requests.delete('http://api.mailhandler.ru/senders/100/',
headers=headers)
print(response.status_code)
Подписчики - Previous
Подписчики
Next - Статистика
Общая статистика
Last modified 3yr ago
Copy link
On this page
Получение списка адресов
Создание адреса
Редактирование адреса
Получение данных адреса
Удаление адреса