Довідник API
Надсилання електронної пошти
Send transactional mail only from your verified custom domains over HTTPS — password resets, receipts, alerts, and similar event-driven messages. Not for newsletters or marketing bulk. One endpoint, domain-scoped API keys, delivery through AWS SES.
Огляд
Створюйте ключі в Обліковий запис → Домени → ваш домен → API після завершення перевірки DNS. Повний секрет показується лише один раз — зберігайте його безпечно. Додаткові облікові дані SMTP у тій же панелі доменів підпорядковуються тим самим правилам лише транзакційних листів.
Лише транзакційні листи
Unbox HTTP API (POST /v1/email) and optional SMTP submission are for transactional mail only — messages tied to an account action, purchase, or operational event. They are not a newsletter or marketing broadcast service.
Дозволене використання
- Підтвердження облікового запису, скидання пароля та сповіщення безпеки
- Підтвердження замовлень, квитанції, оновлення доставки та повідомлення про оплату
- Сповіщення, ініційовані конкретним користувачем або системною подією
- Повідомлення команди та робочого простору (запрошення, призначення, внутрішні сповіщення)
Заборонене використання
- Розсилки, рекламні кампанії або масова маркетингова розсилка
- Холодні розсилки або надсилання на куплені, зібрані чи незгодні списки
- Партнерський спам, фішинг або оманливий контент
- Будь-яка спроба обійти ліміти отримувачів, обмеження швидкості або квоти тарифу
Ліміти швидкості та кількості отримувачів
Для захисту отримувачів і доставності, вихідний трафік API та SMTP підлягає лімітам, зазначеним нижче (додатково до місячної квоти вашого тарифу). Контроль застосовується у веб-редакторі, HTTP API та SMTP. Веб-редактор попереджає після 25 отримувачів на повідомлення та блокує надсилання понад 50.
| Ліміт | Значення |
|---|---|
| Отримувачів на повідомлення | До 50 загалом (To + Cc + Bcc разом) |
| Унікальних отримувачів на день | До 1 000 на робочий простір |
| Швидкість надсилання запитів | До 10 запитів через API або SMTP на хвилину на домен |
| Квота вихідних повідомлень тарифу | Місячні ліміти надсилання відповідно до вашої підписки все ще діють |
Ці правила є частиною нашої Політики допустимого використання. Автоматичний контроль діє у веб-редакторі, HTTP API та SMTP. Облікові записи, які надсилають маркетингові або масові листи, або іншим чином зловживають інфраструктурою, можуть бути обмежені, призупинені або заблоковані.
Ми відстежуємо сигнали доставності. Стійкий рівень відмов понад 3% або скарг понад 0,1% може спричинити тимчасову паузу надсилання або ручну перевірку.
Дивіться наші Умови надання послуг, Політику конфіденційності та Заяву про GDPR для повної інформації про політику.
Автентифікація
Надсилайте ключ API вашого домену в кожному запиті:
Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxxАбо використовуйте X-Api-Key: ubk_live_…. Ключі зберігаються у хешованому вигляді; відкличте або змініть їх у панелі доменів.
Тіло запиту
JSON з назвами полів у PascalCase (From, To, …). camelCase псевдоніми також приймаються.
| Поле | Обов'язкове | Опис |
|---|---|---|
From | Так | Відправник — ваша особиста поштова скринька на домені ключа (основна або псевдонім). Спільні черги не є дійсними відправниками. |
To | Так | Одержувач(і) — рядок, рядок через кому або масив |
Subject | Так | Тема листа |
TextBody | Одне з TextBody / HtmlBody | Текстовий вміст |
HtmlBody | Одне з TextBody / HtmlBody | HTML вміст |
Cc | Ні | Копії одержувачам |
Bcc | Ні | Приховані копії одержувачам |
ReplyTo | Ні | Адреса для відповіді |
Tag | Ні | Необов'язковий тег метаданих (зберігається разом із відправленням) |
Приклад
{
"From": "you@yourdomain.com",
"To": "user@example.com",
"Subject": "Welcome",
"TextBody": "Thanks for signing up.",
"HtmlBody": "<p>Thanks for signing up.</p>",
"ReplyTo": "you@yourdomain.com",
"Tag": "welcome"
}Успішна відповідь
HTTP 200 з JSON:
{
"ErrorCode": 0,
"Message": "OK",
"MessageID": "0100018…-000000-…",
"SubmittedAt": "2026-06-23T12:00:00.000Z",
"To": "user@example.com"
}Помилки
Помилки повертають 4xx (або 500 при неочікуваних збоях) з JSON:
{
"ErrorCode": 300,
"Message": "TextBody or HtmlBody is required."
}| Код помилки | Значення |
|---|---|
0 | Успіх |
10 | Відсутній API-ключ |
11 | Недійсний або відкликаний ключ, або домен не підтверджено для відправлення |
300 | Помилка валідації (відсутні поля, некоректний JSON тощо) |
403 | Адреса відправника не дозволена — має бути ваша особиста поштова скринька на домені ключа |
406 | SES відхилив повідомлення |
Приклади
Замініть you@yourdomain.com на вашу особисту поштову скриньку на домені та використовуйте власний API-ключ.
curl "https://api.unbox.im/v1/email" \
-H "Authorization: Bearer ubk_live_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"From": "you@yourdomain.com",
"To": "user@example.com",
"Subject": "Welcome",
"TextBody": "Thanks for signing up.",
"HtmlBody": "<p>Thanks for signing up.</p>",
"ReplyTo": "you@yourdomain.com",
"Tag": "welcome"
}'Початок роботи
- Створіть обліковий запис Unbox і додайте власний домен.
- Виконайте всі кроки перевірки DNS у розділі «Домени».
- Відкрийте «Домени» → ваш домен → «API» та згенеруйте ключ домену.
- Надішліть перше повідомлення за допомогою прикладів вище.