Методы поделены на несколько групп:
1. Работа с личным кабинетом Mailganer. Стандартные методы по работе с подписчикам, списками, рассылками.
2. Интеграция Mailganer со сторонними приложениями. Группа методов называется \"Работа с пользователями\"
Напишите нам на api@mailganer.com, если вам не хватает какого то метода.
\nМетоды по работе с SMTP задокументированы отдельно и имеют свою отдельную авторизацию
\n1. В методах, содержащих в url v1, авторизация происходит через использование апи ключа в теле запроса в переменной api_key.
2. В методах, содержащих в url v2, авторизация происходит через использование апи ключа в заголовке Authorization: CodeRequest {{api_key}}
API ключ находится в разделе Мои данные
\nК API можно обращаться не чаще 500 раз в минуту. В случае превышения лимита, вы получите ошибку с кодом 429. Напишите нам, если требуется увеличить лимит.
\nНекоторые методы отдают по 25 записей на странице. В переменной count находится количество записей. Ответ находится в json-масиве result. В переменных next и previous находятся ссылки на следующую или предыдущую страницы. Если следующей или предыдущей страницы нет, то вернётся значение null.
\n{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"source\": 1,\n \"title\": \"user_var_float\",\n \"type\": 2,\n \"type_text\": \"Вещественное число\"\n },\n {\n \"source\": 1,\n \"title\": \"user_var_datetime\",\n \"type\": 4,\n \"type_text\": \"Дата и время\"\n }\n ]\n}\n\n\n\nИмейл добавляется в статусе Запрошено подтверждение. На имейл будет отправлено письмо с подтверждением подписки.
\n
Полезная статья: Как изменить стандартное письмо-подтверждение подписки.
Когда подписчик кликнет по ссылке из письма подтверждения, статус изменится на Активен. Параметры not_doi и need_activate по-умолчанию не работают, запросите их активацию в поддержке.
Хэш имейла
\n","type":"text/plain"},"type":"any","value":"a05ad557332370764cd4f267a251f3b13289bcff","key":"email_hash"}]}},"response":[],"_postman_id":"6a6c495c-6736-4b2a-baa5-baeaaef79f1b"},{"name":"Обновление информации о подписчике 2 способ","id":"d1ce8219-d04f-41fa-a380-ac124173e6d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"test@example.com\",\n \"source\": \"51488\",\n \"birthday\": \"05.01.1990\"\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/emails/update/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Имейл, о котором вы хотите получить информацию
\n","type":"text/plain"},"key":"email","value":"test@example.com"},{"description":{"content":"ID списка, в котором находится имейл
\n","type":"text/plain"},"key":"source","value":"51488"}],"variable":[]}},"response":[{"id":"16ea4c2c-fa4c-477d-b1b1-03f5ed9b56cc","name":"Email найден","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://mailganer.com/api/v2/emails/?email=test@example.com&source=51488","protocol":"https","host":["mailganer","com"],"path":["api","v2","emails",""],"query":[{"key":"email","value":"test@example.com","description":"Имейл, о котором вы хотите получить информацию"},{"key":"source","value":"51488","description":"ID списка, в котором находится имейл"}]}},"status":"OK (Email найден)","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Thu, 15 Dec 2022 07:33:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"close"},{"key":"Vary","value":"Accept, Accept-Language, Cookie, Origin"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Language","value":"ru"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 115986334,\n \"mg_hash\": \"ae2f6611598633414be10fe73380863cb59afe7b8\",\n \"email\": \"vlad.tochonii@mailganer.ru\",\n \"source\": 57229,\n \"email_status\": \"active\",\n \"corrected_email\": null,\n \"name\": \"\",\n \"patronymic\": \"\",\n \"surname\": \"\",\n \"gender\": 0,\n \"birthday\": null,\n \"phone\": null,\n \"city\": \"\",\n \"country\": \"\",\n \"is_valid\": true,\n \"doi_is_delivery\": true,\n \"doi_is_open\": false,\n \"doi_is_click\": false,\n \"user_vars\": {\n \"nps\": \"ok\",\n \"test_date\": 1667520000\n },\n \"bunce_log\": null\n }\n ]\n}"},{"id":"289d0e7e-5085-4eac-9bf0-5a86e0c9e779","name":"Email не найден","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://mailganer.com/api/v2/emails/?email=test@example.com&source=51488","protocol":"https","host":["mailganer","com"],"path":["api","v2","emails",""],"query":[{"key":"email","value":"test@example.com","description":"Имейл, о котором вы хотите получить информацию"},{"key":"source","value":"51488","description":"ID списка, в котором находится имейл"}]}},"status":"OK (Email не найден)","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Thu, 15 Dec 2022 07:33:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"close"},{"key":"Vary","value":"Accept, Accept-Language, Cookie, Origin"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Language","value":"ru"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 0,\n \"next\": null,\n \"previous\": null,\n \"results\": []\n}"}],"_postman_id":"74708a54-725e-4d5f-975f-f212241aa60b"},{"name":"Получение информации о подписчике 2 способ","id":"e917fcbe-1b73-41d9-a7bc-dd8e3e469abe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://mailganer.com/api/v2/emails/:email_hash/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Хэш имейла
\n","type":"text/plain"},"type":"any","value":"a05ad557332370764cd4f267a251f3b13289bcff","key":"email_hash"}]}},"response":[],"_postman_id":"e917fcbe-1b73-41d9-a7bc-dd8e3e469abe"},{"name":"Отписка подписчика 1 способ","id":"ef19accb-8086-4818-b203-b03fdf40fddd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://mailganer.com/api/v2/emails/:email_hash/unsubscribe/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Хэш имейла
\n","type":"text/plain"},"type":"any","value":"a05ad557332370764cd4f267a251f3b13289bcff","key":"email_hash"}]}},"response":[],"_postman_id":"ef19accb-8086-4818-b203-b03fdf40fddd"},{"name":"Отписка подписчика 2 способ","id":"d8039ae0-9b88-4484-a898-7a72a771e93e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"test@example.com\",\n \"source\": \"51488\"\n}","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/emails/unsubscribe/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Группа методов для работы с сущностью \"Подписчик\"
\n","_postman_id":"95e94ec2-5951-40ae-99b8-08f52943c379","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Домен, который необходимо проверить
\n","type":"text"}]},"url":"https://mailganer.com/api/v2/sites/verify_domain/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"public_id рассылки вы можете увидеть в личном кабинете, открыв эту рассылку в браузере
\n","type":"text/plain"},"type":"any","value":null,"key":"public_id"}]}},"response":[{"id":"f4c88c40-9d1f-4b01-9c54-805ff2e17bef","name":"Получение информации о рассылке","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://mailganer.com/api/v2/mailing/:public_id","protocol":"https","host":["mailganer","com"],"path":["api","v2","mailing",":public_id"],"variable":[{"key":"public_id","value":null,"description":"public_id рассылки вы можете увидеть в личном кабинете, открыв эту рассылку в браузере"}]}},"status":"Success","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"public_id\": 166775985258,\n \"datetime_send\": \"07.11.2022 03:37\",\n \"send\": \"2022-11-07T03:37:02.141548\",\n \"name\": \"Mailing Name\",\n \"subject\": \"Email subject\",\n \"segment_name\": \"Segment Name\",\n \"segment_id\": 7502,\n \"from_name\": \"Sender Name\",\n \"from_email\": \"info@mailganer.com\",\n \"utm_campaign\": \"166775985258\",\n \"utm_source\": \"mailganer\",\n \"utm_medium\": \"email\",\n \"text\": \"HTML Content\",\n \"count_spam\": 1,\n \"count_unsubscribe\": 14,\n \"count_click\": 448,\n \"count_open\": 1489,\n \"count_delivery\": 13348,\n \"webversion\": \"https://click.mailganer.com/webversion/166775985258/\",\n \"user_utms\": {\n \"custom_param_1\": \"{{custom_param_1}}\"\n }\n}"}],"_postman_id":"3a2161b3-9d18-4b3b-9f84-cfd123549469"},{"name":"Получить список рассылок","id":"b27af799-e9f0-42d8-b8c1-31921a14f018","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://mailganer.com/api/v2/mailing/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"ID триггера
\n","type":"text/plain"},"type":"any","value":"","key":"trigger_id"}]}},"response":[],"_postman_id":"05e525b8-0d19-42db-89a4-9ac12157f472"},{"name":"Статистика триггера","id":"527e4224-28a1-4639-be1a-381a48bae4df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://mailganer.com/api/v2/triggers/:trigger_id/stat/?start_date=2022-08-01&end_date=2023-08-03","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Дата начала
\n","type":"text/plain"},"key":"start_date","value":"2022-08-01"},{"description":{"content":"Дата конца
\n","type":"text/plain"},"key":"end_date","value":"2023-08-03"}],"variable":[{"description":{"content":"ID триггера
\n","type":"text/plain"},"type":"any","value":"1111","key":"trigger_id"}]}},"response":[{"id":"87be530d-ebc9-4d50-8555-422dcf3a6337","name":"С датой","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mailganer.com/api/v2/triggers/:trigger_id/send/?start_date=2022-08-01&end_date=2023-08-03","protocol":"https","host":["mailganer","com"],"path":["api","v2","triggers",":trigger_id","send",""],"query":[{"key":"start_date","value":"2022-08-01","description":"Дата начала"},{"key":"end_date","value":"2023-08-03","description":"Дата конца"}],"variable":[{"key":"trigger_id","value":null,"description":"ID триггера"}]}},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"2023-08-01\": {\n \"delivered\": 338,\n \"clicked\": 13,\n \"opened\": 60,\n \"not_available\": 4,\n \"unsubscribed\": 1,\n \"spammed\": 0,\n \"sent\": 344\n },\n \"2023-08-02\": {\n \"delivered\": 315,\n \"clicked\": 12,\n \"opened\": 54,\n \"not_available\": 0,\n \"unsubscribed\": 2,\n \"spammed\": 0,\n \"sent\": 316\n },\n \"2023-08-03\": {\n \"delivered\": 369,\n \"clicked\": 13,\n \"opened\": 57,\n \"not_available\": 0,\n \"unsubscribed\": 0,\n \"spammed\": 0,\n \"sent\": 369\n },\n \"summary\": {\n \"delivered\": 1022,\n \"clicked\": 38,\n \"opened\": 171,\n \"not_available\": 4,\n \"unsubscribed\": 3,\n \"spammed\": 0,\n \"sent\": 1029\n }\n}"},{"id":"8900485d-ddad-4ecd-ac44-94e48b685f98","name":"Без даты","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mailganer.com/api/v2/triggers/:trigger_id/send/","protocol":"https","host":["mailganer","com"],"path":["api","v2","triggers",":trigger_id","send",""],"variable":[{"key":"trigger_id","value":null,"description":"ID триггера"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"summary\": {\r\n \"delivered\": 163538,\r\n \"clicked\": 7990,\r\n \"opened\": 57910,\r\n \"not_available\": 584,\r\n \"unsubscribed\": 675,\r\n \"spammed\": 931,\r\n \"sent\": 165341\r\n }\r\n}"},{"id":"84f6498d-2cc2-4c65-a7d4-0fb1d6392a14","name":"Ошибка авторизации","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mailganer.com/api/v2/triggers/:trigger_id/send/?start_date=2022-08-01&end_date=2023-08-03","protocol":"https","host":["mailganer","com"],"path":["api","v2","triggers",":trigger_id","send",""],"query":[{"key":"start_date","value":"2022-08-01","description":"Дата начала"},{"key":"end_date","value":"2023-08-03","description":"Дата конца"}],"variable":[{"key":"trigger_id","value":null,"description":"ID триггера"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Thu, 03 Aug 2023 11:46:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"close"},{"key":"Content-Language","value":"ru"},{"key":"Vary","value":"Accept, Accept-Language, Cookie, Origin"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"WWW-Authenticate","value":"CodeRequest"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": \"Недопустимый токен.\"\n}"},{"id":"e2af8ac6-13b2-4169-a88d-e87485fd00d6","name":"Триггер не найден","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mailganer.com/api/v2/triggers/1111/stat/?start_date=2022-08-01&end_date=2023-08-03","protocol":"https","host":["mailganer","com"],"path":["api","v2","triggers","1111","stat",""],"query":[{"key":"start_date","value":"2022-08-01","description":"Дата начала"},{"key":"end_date","value":"2023-08-03","description":"Дата конца"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Thu, 03 Aug 2023 11:47:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"close"},{"key":"Vary","value":"Accept, Accept-Language, Cookie, Origin"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Language","value":"ru"},{"key":"Allow","value":"GET, HEAD, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"error\": \"Не найдено.\"\n}"}],"_postman_id":"527e4224-28a1-4639-be1a-381a48bae4df"},{"name":"Получение статистики по отправке триггера","id":"89ece591-45c3-48e2-a2bd-1df6a429705c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"api_key","value":"XXX","type":"text"},{"key":"id_list","value":"66393144","type":"text"},{"key":"id_list","value":"66393145","type":"text"}]},"url":"https://mailganer.com/api/v1/trigger/id_stat/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"ID пользователя
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"c81e4415-0371-45ed-8ad6-d1acdad667e9"},{"name":"Получить информацию о пользователе","id":"8b336e55-3937-4348-8f69-0568e060dfaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://mailganer.com/api/v2/users/:id/","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"ID пользователя
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"8b336e55-3937-4348-8f69-0568e060dfaf"},{"name":"Получение токена другого пользователя","id":"268a7835-3c40-4059-a5fa-0cdb7a32f442","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Документация по SMTP методам находится в отдельном разделе:
\nhttps://documenter.getpostman.com/view/26779685/2s93RZM9in#intro
\nВ качестве хоста используйте
\nsmtp.mailganer.com для SMTP методов
xml.mailganer.com для пакетных методов