API документация

Документация REST API сервиса SendPulse

Вступление

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

Также в сервисе доступны веб-хуки. Если хотите активировать их в своем аккаунте, напишите, пожалуйста, запрос на [email protected].

Описание

REST API сервиса SendPulse работает по протоколу HTTP и представляет собой набор методов, с помощью которых совершаются запросы и возвращаются ответы для каждой операции. Все ответы приходят в виде JSON структур.

Ограничение на количество запросов - 3 запроса в секунду.

Примеры использования

Основной URL

Все ссылки на запросы к API в данной документации включают обязательный основной URL:
https://api.sendpulse.com

Авторизация

Процесс авторизации возможен при наличии персонального ключа, которым в дальнейшем должен быть подписан каждый запрос к API.

Необходимые для получения ключа параметры можно найти в настройках личного кабинета
https://login.sendpulse.com/settings на вкладке API.

Используются параметры:

grant_type	должен быть равен client_credentials
client_id	ваш ID (API)
client_secret	ваш секрет (API)

Для получения ключа необходимо отправить POST запрос по ссылке:

https://api.sendpulse.com/oauth/access_token

Полученный ключ действителен в течение 1 часа и не требует повторного запроса при каждой операции. По истечении срока действия ключа (1 час) необходимо отправить повторный запрос на получение ключа.

Пример ответа:

{
  "access_token": "tf4Si1LydYpTAPyHXUgjig72jlrd5HpIJL5oigmc",
  "token_type": "Bearer",
  "expires_in": 3600
}

Пример ключа:

Authorization: Bearer tf4Si1LydYpTAPyHXUgjig72jlrd5HpIJL5oigmc

Коды ошибок и их описание

Код ошибки	Описание
8	Отсутствуют данные
10	Отсутствует e-mail адрес отправителя
11	Не указаны получатели
13	Отсутствует контент email сообщения
14	Email адрес с заданным значением ID не найден
17	Email адрес не найден
19	Такой email адрес уже существует
20	Пожалуйста, не используйте бесплатные почтовые сервисы
21	На активации нет указанного email адреса
97	Недопустимый тип email адреса. Использовать аккаунты бесплатных почтовых сервисов не рекомендуется.
201	Отсутствует название адресной книги
203	Адресная книга с указанным именем уже существует
211	Адресная книга пуста
213	Адресная книга не найдена.
303	Отсутствуют email адреса в адресной книге
400	Не существует такого пользователя SMTP. Вам необходимо создать аккаунт в SMTP сервисе.
502	Не найден email адрес
602	Кампания не найдена. Возможно, она была уже отправлена.
701	Отсутствует email адрес или имя отправителя
703	Не найдена адресная книга
704	Не найден отправитель
707	Недостаточно средств на счету
711	Вам следует подождать 15 минут перед повторной попыткой отправки на данную адресную книгу
720	Не указана тема письма
721	Отсутствует контент email сообщения
722	Не указано ID адресной книги
791	Лимит API-кампаний (5 в час) превышен
799	Неправильный формат даты. Должен быть в формате Y-m-d H:i:s и не может быть меньше текущей даты
800	Недопустимое действие
802	Кампания не найдена
901	Не указано имя отправителя
902	Выбранный email адрес уже занят
903	Не указан email адрес отправителя
904	Email адрес найден в черном списке
905	Достигнут лимит доступного количества адресов отправителя
906	Ошибка в email адресе
1101	Не указан email адрес
1003	Указанного отправителя не существует
1004	Код активации был отправлен. Вам следует подождать 15 минут перед повторной попыткой.
1005	Ошибка при отправке подтверждения
1104	Отсутствует код активации