Dokumentacja API

Wysyłaj e-mail

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.

Omówienie

Punkt końcowyhttps://api.unbox.im/v1/email
MetodaPOST
Typ zawartościapplication/json
ZakresJedna klucz API na domenę niestandardową

Generuj klucze w Konto → Domeny → Twoja domena → API po potwierdzeniu DNS. Cały sekret zostanie wyświetlony jednorazowo — przechowuj go bezpiecznie. Opcjonalne dane SMTP w tym samym panelu Domeny podlegają tym samym zasadom tylko transakcyjnym.

Tylko poczta transakcyjna

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.

Dozwolone użycia

  • Weryfikacja konta, resetowanie haseł i ostrzeżenia o bezpieczeństwie
  • Potwierdzenia zamówień, faktury, aktualizacje wysyłki i powiadomienia o płatnościach
  • Powiadomienia wywoływane przez konkretny użytkownika lub zdarzenie systemowe
  • Wiadomości zespołu i przestrzeni roboczej (zaproszenia, przydzielenia, wewnętrzne ostrzeżenia)

Zakazane użycia

  • Listy mailingowe, kampanie promocyjne lub reklama w formacie rozgłosu
  • Kontakt z nieznajomymi lub mail do zakupionych, wykrapionych lub niezgodnych list
  • Spam afiliacyjny, phishing lub treść oszustowska
  • Jakiekolwiek próby obejścia ograniczeń odbiorców, ograniczeń przepustowości lub limitów planu

Limity szybkości i odbiorców

Aby ochronić odbiorców i zapewnić dostarczalność, ruch API i SMTP wychodzący podlega limitom podanym poniżej (poza miesięcznym limitem wychodzącym z planu). Wdrażanie jest aktywne w komponatorze WWW, API HTTP i przesyłaniu SMTP. Komponator WWW ostrzega po 25 odbiorcach na wiadomość i blokuje wysyłanie powyżej 50.

LimitWartość
Odbiorcy na wiadomośćDo 50 łącznie (To + Cc + Bcc łącznie)
Unikalni odbiorcy dziennieDo 1 000 na przestrzeń roboczą
Szybkość żądań wysyłaniaDo 10 submisji API lub SMTP na minutę na domenę
Limit wyjściowy planuOgraniczenia wysyłania miesięczne na Twoje subskrypcję nadal obowiązują

Te zasady są częścią naszej Polityki Użytkowania. Automatyczne wykrywanie jest aktywne w komponatorze web, HTTP API i submisji SMTP. Konta wysyłające marketingowe lub masowe wiadomości, lub w inny sposób abuzując infrastrukturą wysyłania, mogą zostać ograniczone, zablokowane lub zakończone.

Monitorujemy sygnały dostarczalności. Trwałe stopy zwrotu powyżej 3% lub stopy reklamacji powyżej 0,1% mogą wywołać tymczasowe zatrzymanie wysyłania lub ręczną ocenę.

Zobacz nasze Warunki użytkowania, Politykę prywatności oraz Wnioski GDPR dla pełnych szczegółów polityki.

Autoryzacja

Wysyłaj swój klucz API domeny w każdym żądaniu:

Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxx

Alternatywnie, użyj X-Api-Key: ubk_live_…. Klucze są przechowywane w formacie haszowanym; odwołaj lub zmień je z panelu Domen.

Ciało żądania

Plik JSON z nazwami pól w formacie PascalCase (From, To, …). Wersje z camelCase są również akceptowane.

PoleWymaganeOpis
FromTakWysyłający — Twoja osobna skrzynka pocztowa na domenie klucza (główna lub alias). Wspólne kolejki nie są prawidłowymi wysyłającymi.
ToTakOdbiorca(owie) — ciąg znaków, ciąg znaków rozdzielony przecinkiem, lub tablica
SubjectTakLinia tematu
TextBodyJeden z TextBody / HtmlBodyCzysty tekst
HtmlBodyJeden z TextBody / HtmlBodyCiało HTML
CcNieOdbiorcy kopii
BccNieOdbiorcy kopii cenzurowanej
ReplyToNieAdres Reply-To
TagNieOpcjonalny tag metadanych (zapisywany wraz z wiadomością)

Przykład

{
  "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"
}

Odpowiedź sukcesu

HTTP 200 z JSON:

{
  "ErrorCode": 0,
  "Message": "OK",
  "MessageID": "0100018…-000000-…",
  "SubmittedAt": "2026-06-23T12:00:00.000Z",
  "To": "user@example.com"
}

Odpowiedzi błędy

Błędy zwracają 4xx (lub 500 w przypadku nieoczekiwanych błędów) z JSON:

{
  "ErrorCode": 300,
  "Message": "TextBody or HtmlBody is required."
}
Kod błęduZnaczenie
0Sukces
10Brak klucza API
11Nieprawidłowy lub wycofany klucz, lub domena nie zweryfikowana do wysyłania
300Błąd walidacji (brak pól, nieprawidłowy JSON, itp.)
403Adres z niezgodny — musi być Twoja prywatna skrzynka na domenie klucza
406Wiadomość została odrzucona przez SES

Przykłady

Zastąp you@yourdomain.com własną prywatną skrzynką na domenie i użyj własnego klucza 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"
}'

Zacznij używać

  1. Utwórz konto Unbox i dodaj własną domenę niestandardową.
  2. Ukończ wszystkie kroki weryfikacji DNS w Domains.
  3. Otwórz Domains → twoja domena → API i wygeneruj klucz domeny.
  4. Wyślij pierwszą wiadomość za pomocą przykładów powyżej.
Unbox — Dokumentacja API | Unbox.im