Общие сведения

Через программный интерфейс (далее - API) сервиса email рассылок можно отправлять рассылки, одиночные email сообщения, управлять списками получателей, получать статистику рассылки и позволяет использовать прочий функционал.

 

Базовый URL для отправки запросов:

https://api.msndr.net/v1

 

Альтернативный URL для отправки запросов, использующийся в том случае, если основной URL блокирует Роскомнадзор:

 

https://api-reserve.msndr.net/v1

 

Аутентификация осуществляется по “токену” ( Token ).

Этот ключ ( Token ) необходимо отправлять в каждом новом HTTP запросе. Он передаётся с помощью параметра:

Authorization: Bearer $API_TOKEN

 

Ваш “токен” находится в вашем личном кабинете. Не сообщайте его третьим лицам

 

Обмен данными с сервером осуществляется с помощью формата json. Для этого в каждом запросе должен присутствовать заголовок:

Content-Type: application/json

Иногда требуется получить список данных, называемых коллекциями ( Collection ). Некоторые запросы позволяют получить список данных постранично, с определённым количеством строк на странице. Номер страницы задаётся в параметре запроса:

pagenumber

Размер страницы ( количество записей) передаётся в параметре:

pagesize

Пример запроса:

curl -X GET https://api.msndr.net/v1/email/lists?page_number=2&page_size=3 \

     -H 'Content-Type: application/json'         \

     -H 'Authorization: Bearer $API_TOKEN'

 

Если вы превысили максимальный размер запрашиваемой страницы , то вы получите ошибку:

 

 {   

         "errors": [     

           {       

               "code": 412,       

               "detail": "Page size is too big. Max value is 100"     

           }   

         ] 

  }

 

По умолчанию значение page_size , если вы его не задали, равняется 100.

Пример ответа на запрос в котором есть список данных ( collection) . Ответ представляет собой структуру:

{   

       "total_count":23,   

       "total_pages":8,   

       "page_number":2,   

       "page_size":3,   

       "collection":[     

                            {       

                               "id":1,       

                               "title":"My Recipients"     

                            },     

                            {       

                               "id":2,       

                               "title":"My Recipients #2"     

                           },     

                           {       

                              "id":3,       

                              "title":"My Recipients #3"     

                           }   

            ]

      }

Где total_count это общее количество элементов, total_pages  общее количество страниц, page_number номер страницы, page_size размер страницы, collection массив возвращаемых данных.

Ответы на запросы содержат коды. По которым вы можете определить статус завершения запроса.

Ниже приведены коды и их описание

Код

Описание

2xx

Запрос успешно выполнен

400

Неверные параметры

401

Аутентификация не пройдена

402

Недостаточно средств

404

Ресурс не найден

415

Неподдерживаемый тип данных

422

Ресурс не может быть обработан

500

Неизвестная ошибка

  • 34 Пользователи нашли это полезным
Помог ли вам данный ответ?

Связанные статьи

Управление параметрами групп получателей

Создание параметра группы Пример json данных для HTTP запроса: { "title":"Age", "kind":...

Ограничения вводимые сервисом для предотвращения спам рассылки

Для предотвращения спам рассылки , предусмотрен механизм ограничения числа отправлений. В личном...

Получение текущего баланса

Чтобы получить информацию по вашему балансу нужно выполнить следующий HTTP запрос: curl -X GET...

Отправка одного сообщения

Отправка одного email сообщения Пример json данных для запроса: {...

Получение информация о шаблонах

Получить список шаблонов вы можете следующим HTTP запросом: curl -X GET...