Начало работы
Справочник API
Полный справочник по всем конечным точкам API Emailit v2, форматам запросов и схемам ответов.
Базовый URL
Все API-запросы должны отправляться на следующий базовый URL. Мы поддерживаем только защищённые HTTPS запросы.
Текущая версия нашего API — v2 со следующим базовым URL:
Аутентификация
API Emailit v2 использует API-ключи для аутентификации запросов. Вы можете просматривать и управлять своими API-ключами в панели управления Emailit.
Ваши API-ключи предоставляют широкие права доступа, поэтому обязательно храните их в безопасности! Не размещайте секретные API-ключи в общедоступных местах, таких как GitHub, клиентский код и т.д.
Ограничения скорости
Наш API v2 и SMTP имеют начальное ограничение скорости 2 сообщения в секунду для новых рабочих пространств. Вы всегда можете запросить более высокое ограничение скорости в панели управления Emailit.
Каждое рабочее пространство также имеет начальное ограничение 5000 сообщений в день.
Коды ответов
API использует стандартные HTTP-коды ответов для указания успеха или неудачи операции.
| Код состояния | Описание |
|---|---|
| 200 | OK - Запрос выполнен успешно |
| 400 | Неверный запрос - Некорректные параметры запроса |
| 401 | Не авторизован - Неверный или отсутствующий API-ключ |
| 403 | Доступ запрещён - Нет доступа к запрашиваемому ресурсу |
| 404 | Не найден - Запрашиваемый ресурс не существует |
| 429 | Слишком много запросов - Превышено ограничение скорости |
| 500 | Внутренняя ошибка сервера - Что-то пошло не так на нашей стороне |