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

Документация к API FirstSender Текущая версия 1.0.1

Библиотеки

Название: FirstSender

Язык: PHP

Репозиторий на GitHub: https://github.com/FirstSender/php_firstsender

Если Вы столкнулись с трудностями или Вам кажется что какой-то из методов не работает - пишите нам и Вам быстро помогут наши специалисты.

Как обращаться к API?

Работа с API осуществляется при помощи отправки HTTP-запросов (метод POST) по адресу:

https://api.firstsender.com/

Возможно использование только протокола HTTPS. Кодировка: UTF-8. Пример запроса:

https://api.firstsender.com/account.get_access_token.json

Формирование ссылки происходит исходя из метода. Ссылке выше соответствует метод account.get_access_token

Параметры отправлюятся методом POST

Возвращаемые данные

Сервер возвращает ответ в нескольких форматах,
для смены формата используйте в адресе расширение после метода (json или xml):

JSON
XML

Возвращаемые данные отмечаются статусом success, он может быть равным true (если запрос выполнен успешно)
или false (если при выполнении запроса возникла ошибка).

Если сервер вернул статус false, то Вы так же получите код ошибки (error_code) и сообщение об ошибке (error)

Коды ошибок

Категории методов

account - Методы для работы с личным аккаунтом

campaign - Методы для работы с кампаниями рассылок

mailer_notification - Методы для работы с системными уведомлениями

list - Методы для работы с подписчиками

Методы для работы с личным аккаунтом

account.get_access_token (string $email, string $password)

Получение ключа доступа(нужен для всех остальных методов)

account.get_limits (string $access_token)

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

Методы для работы с кампаниями рассылки

campaign.create (string $access_token, string $subject, string $content, integer $start, string $start_date, string $start_time, integer $reply_to, array $list_info, string $styles)

Создание кампании рассылки

campaign.get_items (string $access_token, integer $limit, integer $offset)

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

campaign.get_item (string $access_token, integer $campaign_id)

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

campaign.remove (string $access_token, integer $campaign_id)

Удаление кампании рассылки

Методы для работы с системными уведомлениями

mailer_notification.send (string $access_token, integer $template_id, array $vars, string $email)

Отправка уведомления

mailer_notification.list (string $access_token, integer $limit, integer $offset)

Получения списка шаблонов уведомлений

mailer_notification.log (string $access_token, integer $template_id, integer $limit, integer $offset)

Получения лога отправок шаблонов уведомлений

Методы для работы со списками подписчиков

list.create (string $access_token, string $name)

Создает список подписчиков

list.get_items (string $access_token, integer $limit, integer $offset)

Получение списков подписчиков

list.get_item (string $access_token, integer $list_id)

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

list.remove (string $access_token, integer $list_id)

Удаление списка подписчиков

list.import_create (string $access_token, integer $list_id, string $name, file $file, integer $file_type)

Создает импорт в списке подписчиков

list.get_import_items (string $access_token, integer $list_id, integer $limit, integer $offset)

Получение списка импортов подписчиков

list.get_import_item (string $access_token, integer $import_id)

Получение импорта подписчиков

list.get_import_log (string $access_token, integer $import_id)

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

list.import_remove (string $access_token, integer $import_id)

Удаление импорта подписчиков

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