Добавление адресов

С помощью API вы можете создавать, редактировать и удалять адреса для отправки ваших писем.
Базовый URL: http://api.mailhandler.ru/senders/​
Получение списка адресов
Отправьте GET запрос на URL http://api.mailhandler.ru/senders/. Запрос не должен содержать параметров.
В результате вы получите ответ в формате JSON со списком созданных вами адресов для отправки.
Bash
Python
Пример получения списка объектов с помощью curl:
1
curl 'http://api.mailhandler.ru/senders/' \ 
2
-X GET \ -H 'Accept: application/json' \ 
3
-H 'Content-Type: application/json' \ 
4
-H 'X-Secure-Token: <YOUR_TOKEN>'
Copied!
Пример получения списка объектов на python:
1
import requests 
2
​
3
def get_list():     
4
    headers = {         
5
        'X-Secure-Token': '<YOUR_TOKEN>',         
6
        'Accept': 'application/json',         
7
        'Content-Type': 'application/json',     
8
    }      
9
    response = requests.get('http://api.mailhandler.ru/senders/',                              
10
                  json=data, 
11
                  headers=headers)     
12
    print(response.status_code)
Copied!
В случае успешного выполнения запроса вы получите ответ в формате JSON со статусом 200 OK
1
{
2
  "count": 1,
3
  "next": null,
4
  "previous": null,
5
  "results": [{
6
      "id": 106,
7
      "full_name": "Иван Петров",
8
      "from_email": "[email protected]",
9
      "reply_to_email": "",
10
      "is_verified": false
11
    }]
12
}
Copied!
Создание адреса
Отправьте POST запрос на URL http://api.mailhandler.ru/senders/. Запрос должен содержать следующие параметры:
Название
Описание
Обязателен
Пример
full_name
Полное имя отправителя
Да
Иван Петров
from_email
Адрес Email
Да
[email protected]
reply_to_email
Адрес Email для получения ответов
Нет
[email protected]
В результате успешного создания объекта вы получите ответ в формате JSON с данными созданного объекта:
Название
Описание
Пример
id
Идентификатор объекта
100
full_name
Полное имя отправителя
Иван Петров
from_email
Адрес Email
[email protected]
reply_to_email
Адрес Email для получения ответов
[email protected]
is_verified
Подтвержден адрес или нет, boolean
false
date_created
Дата создания объекта
2017-03-15T10:21:56.854530
Внимание: на адрес, который вы передали в качестве значения параметра from_email будет отправлено письмо с ссылкой для его подтверждения. Чтобы использовать этот адрес для отправки писем, вам необходимо будет перейти по этой ссылке.
Bash
Python
Пример создания объекта с помощью curl:
1
curl 'http://api.mailhandler.ru/senders/' \ 
2
-X POST \ -H 'Accept: application/json' \ 
3
-H 'Content-Type: application/json' \ 
4
-H 'X-Secure-Token: <YOUR_TOKEN>' \ 
5
-d '{"full_name":"Иван Петров", "from_email":"[email protected]"}'
Copied!
Пример создания объекта на python:
1
import requests 
2
​
3
def create():     
4
    headers = {         
5
        'X-Secure-Token': '<YOUR_TOKEN>',         
6
        'Accept': 'application/json',         
7
        'Content-Type': 'application/json',     
8
    }     
9
    data = {         
10
        'full_name': 'Иван Петров',         
11
        'from_email': '[email protected]'
12
    }     
13
    response = requests.post('http://api.mailhandler.ru/senders/',                              
14
                  json=data, 
15
                  headers=headers)     
16
    print(response.status_code)
Copied!
В случае успешного создания объекта вы получите ответ в формате JSON со статусом 201 Created
1
{
2
      "id": 106,
3
      "full_name": "Иван Петров",
4
      "from_email": "[email protected]",
5
      "reply_to_email": "",
6
      "is_verified": false
7
}
Copied!
Редактирование адреса
Отправьте PUT или PATCH запрос на URL http://api.mailhandler.ru/senders/{sender_id}/, где sender_id - идентификатор нужного вам адреса.
Запрос может содержать следующие параметры:
Название
Описание
Обязателен
Пример
full_name
Полное имя отправителя
Да
Иван Петров
from_email
Адрес Email
Да
[email protected]
reply_to_email
Адрес Email для получения ответов
Нет
[email protected]
В результате успешного создания объекта вы получите ответ в формате JSON с данными отредактированного объекта:
Название
Описание
Пример
id
Идентификатор объекта
100
full_name
Полное имя отправителя
Иван Петров
from_email
Адрес Email
[email protected]
reply_to_email
Адрес Email для получения ответов
[email protected]
is_verified
Подтвержден адрес или нет, boolean
false
date_created
Дата создания объекта
2017-03-15T10:21:56.854530
Bash
Python
Пример редактирования объекта с помощью curl:
1
curl 'http://api.mailhandler.ru/senders/100/' \ 
2
-X PATCH \ -H 'Accept: application/json' \ 
3
-H 'Content-Type: application/json' \ 
4
-H 'X-Secure-Token: <YOUR_TOKEN>' \ 
5
-d '{"from_email":"[email protected]"}'
Copied!
Пример редактирования объекта на python:
1
import requests 
2
​
3
def edit():     
4
    headers = {         
5
        'X-Secure-Token': '<YOUR_TOKEN>',         
6
        'Accept': 'application/json',         
7
        'Content-Type': 'application/json',     
8
    }     
9
    data = {         
10
        'from_email': '[email protected]'
11
    }     
12
    response = requests.patch('http://api.mailhandler.ru/senders/100/',                              
13
                  json=data, 
14
                  headers=headers)     
15
    print(response.status_code)
Copied!
В случае успешного изменения объекта вы получите ответ в формате JSON со статусом 200 OK
1
{
2
      "id": 106,
3
      "full_name": "Иван Петров",
4
      "from_email": "[email protected]",
5
      "reply_to_email": "",
6
      "is_verified": true
7
}
Copied!
Получение данных адреса
Отправьте GET запрос на URL http://api.mailhandler.ru/senders/{sender_id}/, где sender_id - идентификатор нужного вам адреса.
Запрос не должен содержать параметров.
В результате успешного запроса вы получите ответ в формате JSON с данными отредактированного объекта:
Название
Описание
Пример
id
Идентификатор объекта
100
full_name
Полное имя отправителя
Иван Петров
from_email
Адрес Email
[email protected]
reply_to_email
Адрес Email для получения ответов
[email protected]
is_verified
Подтвержден адрес или нет, boolean
false
date_created
Дата создания объекта
2017-03-15T10:21:56.854530
Bash
Python
Пример получения данных объекта с помощью curl:
1
curl 'http://api.mailhandler.ru/senders/100' \ 
2
-X GET \ -H 'Accept: application/json' \ 
3
-H 'Content-Type: application/json' \ 
4
-H 'X-Secure-Token: <YOUR_TOKEN>'
Copied!
Пример получения данных объекта на python:
1
import requests 
2
​
3
def get():     
4
    headers = {         
5
        'X-Secure-Token': '<YOUR_TOKEN>',         
6
        'Accept': 'application/json',         
7
        'Content-Type': 'application/json',     
8
    }     
9
    response = requests.get('http://api.mailhandler.ru/senders/100/',
10
                  headers=headers)     
11
    print(response.status_code)
Copied!
В случае успешного получения данных объекта вы получите ответ в формате JSON со статусом 200 OK
1
{
2
      "id": 106,
3
      "full_name": "Иван Петров",
4
      "from_email": "[email protected]",
5
      "reply_to_email": "",
6
      "is_verified": true
7
}
Copied!
Удаление адреса
Отправьте DELETE запрос на URL http://api.mailhandler.ru/senders/{sender_id}/, где sender_id - идентификатор нужного вам адреса.
Запрос не должен содержать параметров.
В результате успешного запроса вы получите ответ со статусом 204 No Content.
Bash
Python
Пример удаления объекта с помощью curl:
1
curl 'http://api.mailhandler.ru/senders/100' \ 
2
-X DELETE \ -H 'Accept: application/json' \ 
3
-H 'Content-Type: application/json' \ 
4
-H 'X-Secure-Token: <YOUR_TOKEN>'
Copied!
Пример удаления объекта на python:
1
import requests 
2
​
3
def delete():     
4
    headers = {         
5
        'X-Secure-Token': '<YOUR_TOKEN>',         
6
        'Accept': 'application/json',         
7
        'Content-Type': 'application/json',     
8
    }     
9
    response = requests.delete('http://api.mailhandler.ru/senders/100/',
10
                  headers=headers)     
11
    print(response.status_code)
Copied!
Подписчики - Previous
Подписчики
Next - Статистика
Общая статистика
Last modified 3yr ago
Copy link
Contents
Получение списка адресов
Создание адреса
Редактирование адреса
Получение данных адреса
Удаление адреса