Общая информация

Формат передаваемых данных

application/json

Формат ответа

application/json

Авторизация

Сервер-сервер API проверяет авторизацию и IP адрес клиента. Логин и секрет передаются с помощью Basic HTTP Authorization, в заголовке Authorization Authorization: Basic base64('login:secret') Логин и секрет и список разрешенных IP адресов могут быть изменены в настройках проекта

Формат dataurl

"data:[mediatype];base64,[data in base64]"

Поддерживаемые mediatype

text/html

application/zip

Описание методов

GET /api/v2/letter/

Получение списка писем

POST /api/v2/letter/

Создание письма

Параметры

Параметр	Тип	Обязательный	Описание
category	int	Да	Category
from_address	string	Да	From address
subject	string	Нет	Subject
internal_name	string	Нет	Внутреннее имя
subject_ru	string	Нет	Тема письма [ru]
subject_en	string	Нет	Тема письма [en]
subject_de	string	Нет	Тема письма [de]
subject_fr	string	Нет	Тема письма [fr]
subject_it	string	Нет	Тема письма [it]
subject_es	string	Нет	Тема письма [es]
subject_tr	string	Нет	Тема письма [tr]
subject_pl	string	Нет	Тема письма [pl]
subject_zh	string	Нет	Тема письма [zh]
subject_ko	string	Нет	Тема письма [ko]
text_html	string	Нет	HTML шаблон письма
text_html_ru	string	Нет	HTML шаблон письма [ru]
text_html_en	string	Нет	HTML шаблон письма [en]
text_html_de	string	Нет	HTML шаблон письма [de]
text_html_fr	string	Нет	HTML шаблон письма [fr]
text_html_it	string	Нет	HTML шаблон письма [it]
text_html_es	string	Нет	HTML шаблон письма [es]
text_html_tr	string	Нет	HTML шаблон письма [tr]
text_html_pl	string	Нет	HTML шаблон письма [pl]
text_html_zh	string	Нет	HTML шаблон письма [zh]
text_html_ko	string	Нет	HTML шаблон письма [ko]
text_plain	string	Нет	Версия без HTML
text_plain_ru	string	Нет	Версия без HTML [ru]
text_plain_en	string	Нет	Версия без HTML [en]
text_plain_de	string	Нет	Версия без HTML [de]
text_plain_fr	string	Нет	Версия без HTML [fr]
text_plain_it	string	Нет	Версия без HTML [it]
text_plain_es	string	Нет	Версия без HTML [es]
text_plain_tr	string	Нет	Версия без HTML [tr]
text_plain_pl	string	Нет	Версия без HTML [pl]
text_plain_zh	string	Нет	Версия без HTML [zh]
text_plain_ko	string	Нет	Версия без HTML [ko]
x_amp_html	string	Нет	X-AMP-HTML шаблон письма
x_amp_html_ru	string	Нет	X-AMP-HTML шаблон письма [ru]
x_amp_html_en	string	Нет	X-AMP-HTML шаблон письма [en]
x_amp_html_de	string	Нет	X-AMP-HTML шаблон письма [de]
x_amp_html_fr	string	Нет	X-AMP-HTML шаблон письма [fr]
x_amp_html_it	string	Нет	X-AMP-HTML шаблон письма [it]
x_amp_html_es	string	Нет	X-AMP-HTML шаблон письма [es]
x_amp_html_tr	string	Нет	X-AMP-HTML шаблон письма [tr]
x_amp_html_pl	string	Нет	X-AMP-HTML шаблон письма [pl]
x_amp_html_zh	string	Нет	X-AMP-HTML шаблон письма [zh]
x_amp_html_ko	string	Нет	X-AMP-HTML шаблон письма [ko]
is_urgent	boolean	Нет	Транзакционное письмо
not_add_unsubscr_link	boolean	Нет	Не добавлять ссылку на отписку
not_add_web_view_link	boolean	Нет	Не добавлять ссылку на web-версию
file_html	string	Нет	File html в формате dataurl
file_html_ru	string	Нет	File html ru в формате dataurl
file_html_en	string	Нет	File html en в формате dataurl
file_html_de	string	Нет	File html de в формате dataurl
file_html_fr	string	Нет	File html fr в формате dataurl
file_html_it	string	Нет	File html it в формате dataurl
file_html_es	string	Нет	File html es в формате dataurl
file_html_tr	string	Нет	File html tr в формате dataurl
file_html_pl	string	Нет	File html pl в формате dataurl
file_html_zh	string	Нет	File html zh в формате dataurl
file_html_ko	string	Нет	File html ko в формате dataurl

GET /api/v2/letter/{id}/

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

PUT /api/v2/letter/{id}/

Перезапись письма

Параметры

Параметр	Тип	Обязательный	Описание
category	int	Да	Category
from_address	string	Да	From address
subject	string	Нет	Subject
internal_name	string	Нет	Внутреннее имя
subject_ru	string	Нет	Тема письма [ru]
subject_en	string	Нет	Тема письма [en]
subject_de	string	Нет	Тема письма [de]
subject_fr	string	Нет	Тема письма [fr]
subject_it	string	Нет	Тема письма [it]
subject_es	string	Нет	Тема письма [es]
subject_tr	string	Нет	Тема письма [tr]
subject_pl	string	Нет	Тема письма [pl]
subject_zh	string	Нет	Тема письма [zh]
subject_ko	string	Нет	Тема письма [ko]
text_html	string	Нет	HTML шаблон письма
text_html_ru	string	Нет	HTML шаблон письма [ru]
text_html_en	string	Нет	HTML шаблон письма [en]
text_html_de	string	Нет	HTML шаблон письма [de]
text_html_fr	string	Нет	HTML шаблон письма [fr]
text_html_it	string	Нет	HTML шаблон письма [it]
text_html_es	string	Нет	HTML шаблон письма [es]
text_html_tr	string	Нет	HTML шаблон письма [tr]
text_html_pl	string	Нет	HTML шаблон письма [pl]
text_html_zh	string	Нет	HTML шаблон письма [zh]
text_html_ko	string	Нет	HTML шаблон письма [ko]
text_plain	string	Нет	Версия без HTML
text_plain_ru	string	Нет	Версия без HTML [ru]
text_plain_en	string	Нет	Версия без HTML [en]
text_plain_de	string	Нет	Версия без HTML [de]
text_plain_fr	string	Нет	Версия без HTML [fr]
text_plain_it	string	Нет	Версия без HTML [it]
text_plain_es	string	Нет	Версия без HTML [es]
text_plain_tr	string	Нет	Версия без HTML [tr]
text_plain_pl	string	Нет	Версия без HTML [pl]
text_plain_zh	string	Нет	Версия без HTML [zh]
text_plain_ko	string	Нет	Версия без HTML [ko]
x_amp_html	string	Нет	X-AMP-HTML шаблон письма
x_amp_html_ru	string	Нет	X-AMP-HTML шаблон письма [ru]
x_amp_html_en	string	Нет	X-AMP-HTML шаблон письма [en]
x_amp_html_de	string	Нет	X-AMP-HTML шаблон письма [de]
x_amp_html_fr	string	Нет	X-AMP-HTML шаблон письма [fr]
x_amp_html_it	string	Нет	X-AMP-HTML шаблон письма [it]
x_amp_html_es	string	Нет	X-AMP-HTML шаблон письма [es]
x_amp_html_tr	string	Нет	X-AMP-HTML шаблон письма [tr]
x_amp_html_pl	string	Нет	X-AMP-HTML шаблон письма [pl]
x_amp_html_zh	string	Нет	X-AMP-HTML шаблон письма [zh]
x_amp_html_ko	string	Нет	X-AMP-HTML шаблон письма [ko]
is_urgent	boolean	Нет	Транзакционное письмо
not_add_unsubscr_link	boolean	Нет	Не добавлять ссылку на отписку
not_add_web_view_link	boolean	Нет	Не добавлять ссылку на web-версию
in_archive	boolean	Нет	В архиве
file_html	string	Нет	File html в формате dataurl
file_html_ru	string	Нет	File html ru в формате dataurl
file_html_en	string	Нет	File html en в формате dataurl
file_html_de	string	Нет	File html de в формате dataurl
file_html_fr	string	Нет	File html fr в формате dataurl
file_html_it	string	Нет	File html it в формате dataurl
file_html_es	string	Нет	File html es в формате dataurl
file_html_tr	string	Нет	File html tr в формате dataurl
file_html_pl	string	Нет	File html pl в формате dataurl
file_html_zh	string	Нет	File html zh в формате dataurl
file_html_ko	string	Нет	File html ko в формате dataurl

PATCH /api/v2/letter/{id}/

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

Параметры

Параметр	Тип	Обязательный	Описание
category	int	Да	Category
from_address	string	Да	From address
subject	string	Нет	Subject
internal_name	string	Нет	Внутреннее имя
subject_ru	string	Нет	Тема письма [ru]
subject_en	string	Нет	Тема письма [en]
subject_de	string	Нет	Тема письма [de]
subject_fr	string	Нет	Тема письма [fr]
subject_it	string	Нет	Тема письма [it]
subject_es	string	Нет	Тема письма [es]
subject_tr	string	Нет	Тема письма [tr]
subject_pl	string	Нет	Тема письма [pl]
subject_zh	string	Нет	Тема письма [zh]
subject_ko	string	Нет	Тема письма [ko]
text_html	string	Нет	HTML шаблон письма
text_html_ru	string	Нет	HTML шаблон письма [ru]
text_html_en	string	Нет	HTML шаблон письма [en]
text_html_de	string	Нет	HTML шаблон письма [de]
text_html_fr	string	Нет	HTML шаблон письма [fr]
text_html_it	string	Нет	HTML шаблон письма [it]
text_html_es	string	Нет	HTML шаблон письма [es]
text_html_tr	string	Нет	HTML шаблон письма [tr]
text_html_pl	string	Нет	HTML шаблон письма [pl]
text_html_zh	string	Нет	HTML шаблон письма [zh]
text_html_ko	string	Нет	HTML шаблон письма [ko]
text_plain	string	Нет	Версия без HTML
text_plain_ru	string	Нет	Версия без HTML [ru]
text_plain_en	string	Нет	Версия без HTML [en]
text_plain_de	string	Нет	Версия без HTML [de]
text_plain_fr	string	Нет	Версия без HTML [fr]
text_plain_it	string	Нет	Версия без HTML [it]
text_plain_es	string	Нет	Версия без HTML [es]
text_plain_tr	string	Нет	Версия без HTML [tr]
text_plain_pl	string	Нет	Версия без HTML [pl]
text_plain_zh	string	Нет	Версия без HTML [zh]
text_plain_ko	string	Нет	Версия без HTML [ko]
x_amp_html	string	Нет	X-AMP-HTML шаблон письма
x_amp_html_ru	string	Нет	X-AMP-HTML шаблон письма [ru]
x_amp_html_en	string	Нет	X-AMP-HTML шаблон письма [en]
x_amp_html_de	string	Нет	X-AMP-HTML шаблон письма [de]
x_amp_html_fr	string	Нет	X-AMP-HTML шаблон письма [fr]
x_amp_html_it	string	Нет	X-AMP-HTML шаблон письма [it]
x_amp_html_es	string	Нет	X-AMP-HTML шаблон письма [es]
x_amp_html_tr	string	Нет	X-AMP-HTML шаблон письма [tr]
x_amp_html_pl	string	Нет	X-AMP-HTML шаблон письма [pl]
x_amp_html_zh	string	Нет	X-AMP-HTML шаблон письма [zh]
x_amp_html_ko	string	Нет	X-AMP-HTML шаблон письма [ko]
is_urgent	boolean	Нет	Транзакционное письмо
not_add_unsubscr_link	boolean	Нет	Не добавлять ссылку на отписку
not_add_web_view_link	boolean	Нет	Не добавлять ссылку на web-версию
in_archive	boolean	Нет	В архиве
file_html	string	Нет	File html в формате dataurl
file_html_ru	string	Нет	File html ru в формате dataurl
file_html_en	string	Нет	File html en в формате dataurl
file_html_de	string	Нет	File html de в формате dataurl
file_html_fr	string	Нет	File html fr в формате dataurl
file_html_it	string	Нет	File html it в формате dataurl
file_html_es	string	Нет	File html es в формате dataurl
file_html_tr	string	Нет	File html tr в формате dataurl
file_html_pl	string	Нет	File html pl в формате dataurl
file_html_zh	string	Нет	File html zh в формате dataurl
file_html_ko	string	Нет	File html ko в формате dataurl