Добавление адресов
С помощью API вы можете создавать, редактировать и удалять адреса для отправки ваших писем.
Базовый URL: http://api.mailhandler.ru/senders/
Отправьте GET запрос на URL http://api.mailhandler.ru/senders/. Запрос не должен содержать параметров.
В результате вы получите ответ в формате JSON со списком созданных вами адресов для отправки.
Пример получения списка объектов с помощью 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 requestsdef 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/. Запрос должен содержать следующие параметры:
Название | Описание | Обязателен | Пример |
| Полное имя отправителя | Да | Иван Петров |
| Адрес Email | Да | |
| Адрес Email для получения ответов | Нет |
В результате успешного создания объекта вы получите ответ в формате JSON с данными созданного объекта:
Название | Описание | Пример |
| Идентификатор объекта | 100 |
| Полное имя отправителя | Иван Петров |
| Адрес Email | |
| Адрес Email для получения ответов | |
| Подтвержден адрес или нет, |
|
| Дата создания объекта |
|
Внимание: на адрес, который вы передали в качестве значения параметра from_email будет отправлено письмо с ссылкой для его подтверждения. Чтобы использовать этот адрес для отправки писем, вам необходимо будет перейти по этой ссылке.
Пример создания объекта с помощью 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 requestsdef 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 - идентификатор нужного вам адреса.
Запрос может содержать следующие параметры:
Название | Описание | Обязателен | Пример |
| Полное имя отправителя | Да | Иван Петров |
| Адрес Email | Да | |
| Адрес Email для получения ответов | Нет |
В результате успешного создания объекта вы получите ответ в формате JSON с данными отредактированного объекта:
Название | Описание | Пример |
| Идентификатор объекта | 100 |
| Полное имя отправителя | Иван Петров |
| Адрес Email | |
| Адрес Email для получения ответов | |
| Подтвержден адрес или нет, |
|
| Дата создания объекта |
|
Пример редактирования объекта с помощью 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 requestsdef 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 с данными отредактированного объекта:
Название | Описание | Пример |
| Идентификатор объекта | 100 |
| Полное имя отправителя | Иван Петров |
| Адрес Email | |
| Адрес Email для получения ответов | |
| Подтвержден адрес или нет, |
|
| Дата создания объекта |
|
Пример получения данных объекта с помощью 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 requestsdef 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.
Пример удаления объекта с помощью 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 requestsdef 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)