REST API
Ваш почтовый ящик по обычному HTTP.
Отправляйте, читайте и управляйте почтой из собственного кода. У каждого ключа есть только те области доступа, которые вы ему дали.
Коротко
Что такое почтовый API?
Почтовый API позволяет программам отправлять и читать почту по HTTP, а не через приложение. Ключ в каждом запросе решает, к чему вызывающему можно прикасаться.
104
документированные операции
25
целых доменов в области отправки одного ключа
50
отдельных адресов сверх них
Как это работает
Ограничьте каждый ключ одной задачей
Выберите области доступа ключа и, если нужно, отправителей, от имени которых он может писать. Без нужной области или с отправителем не из списка ответ будет 403.
Повтор без двойной отправки
Каждая отправка получает свой id msg_ ещё до того, как что-либо уйдёт. Повтор с тем же Idempotency-Key вернёт первый результат.
Смените секрет, сохраните ключ
Смена заменяет только секрет, поэтому id, области доступа и история запросов сохраняются. Отозванному ключу отвечают revoked_api_key.
Области доступа для ключа
Всего тридцать. Новые ключи начинают с emails:send.
Отправьте первое письмо
Обычные HTTP и JSON. Ничего не нужно устанавливать.
curl -X POST https://api.openemail.uk/emails \ -H "Authorization: Bearer $OPENEMAIL_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "from": "Acme Billing <[email protected]>", "to": ["[email protected]"], "subject": "Your September invoice", "html": "<p>Invoice attached.</p>" }'Что вы получаете
Уже в продукте
У каждой отправки есть id
/events по каждому получателю, /tracking для открытий и кликов.
403 с объяснением
GET /ping показывает области доступа ключа и то, что оставила ему роль.
Ключи через MCP
MCP-сервер тоже показывает, меняет, отзывает и включает ключи.
Советы
Как извлечь максимум
- 01
Один ключ на сервис
Тогда отзыв утёкшего ключа остановит одну интеграцию, а не все.
- 02
Задайте Idempotency-Key
Стройте его из уникального значения, например номера счёта, чтобы повтор возвращал прежний ответ.
- 03
Сузьте отправителя
Укажите только адреса, с которых пишет сервис. Целый домен охватывает и адреса, добавленные позже.
Положение дел
Полезно знать
- Нет эндпоинта загрузки
- Встроенные вложения передаются в base64, всего до 5 МБ. Файлы больше идут по id файла в рабочем пространстве, ссылкой на скачивание.
- У отправки нет статуса возврата
- GET /emails показывает отклонённое письмо как отправленное. Возврат виден у его получателя и в вебхуке email.bounced.
Вопросы
Часто спрашивают
Что дальше
Хорошо сочетается с
Начать
Ваш домен,
ваша почта.
Направьте домен на OpenEmail и читайте его почту в ящике, построенном вокруг него. Бесплатный тариф включает один домен.
