API hivatkozás
E-mail küldés
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.
Áttekintés
Generálja a Fiók → Tartományok → a tartományod → API menüben a DNS-ellenőrzés befejezése után. A teljes titkosított kulcs egyszer megjelenik – biztonságosan tárolja. A Domains panelben található opciós SMTP hitelesítő adatok ugyanazokat a tranzakciós csak szabályokat követik.
Csak tranzakciós levelezés
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.
Engedélyezett használatok
- Fiók ellenőrzés, jelszó visszaállítás és biztonsági figyelmeztetések
- Rendelés-igazolások, számlák, szállítási frissítések és fizetési értesítések
- Események vagy rendszeres események által aktivált értesítések
- Csoport- és munkaterületi üzenetek (hívások, feladatok, belső figyelmeztetések)
Tiltott használatok
- Hírlevél, marketing kampányok vagy hírlevélküldés
- Hűvös elérés vagy küldés vásárolt, kibányászott vagy nem hozzájáruló listákra
- Közvetítő spam, csalás vagy csaló tartalmak
- Bármely kísérlet a fogadók korlátainak, küldési korlátoknak vagy tervkvótáknak elkerülésére
Küldési és fogadó korlátok
A fogadók védelmének és eljuttatásának biztosítása érdekében az outbound API és SMTP forgalmat a következő korlátokra vonatkozóan szabályozzuk (az Ön havi küldési kvóta mellett). A szabályozás aktív a webes szerkesztőn, HTTP API-on és SMTP küldésen. A webes szerkesztő figyelmeztet a 25 fogadó után üzenetenként, és blokkolja a 50-nél több fogadó küldését.
| Korlát | Érték |
|---|---|
| Fogadók üzenetenként | Maximum 50 összesen (To + Cc + Bcc kombinálva) |
| Egyedi fogadók napi száma | Maximum 1 000 egy munkaterületen |
| Küldési kérelem gyakorisága | Maximum 10 API vagy SMTP küldés percenként egy tartományra |
| Terv küldési kvóta | A megrendelt küldési korlátok a havi küldési kvótában továbbra is érvényesek |
Ezek a szabályok részei a megfelelő használati politikánknak. Az automatikus szabályozás aktív a webes szerkesztőn, HTTP API-on és SMTP küldésen. A marketinget vagy nagy mennyiségű levelet küldő fiókok, valamint az általános küldési infrastruktúra megbízhatóságát megsértő fiókok leállíthatók, felfüggeszthetők vagy megszüntethetők.
Monitorozzuk a szállítási jeleket. A 3% feletti tartós visszautasítási arány vagy a 0,1% feletti panaszok aránya időszakos küldési szünetet vagy manuális ellenőrzést indíthat.
Lásd a Használati feltételek, Adatvédelmi nyilatkozat és GDPR nyilatkozat részletesebb politikai információkat.
Hitelesítés
Küldje meg a tartomány API kulcsát minden kérelemmel:
Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxxVagy használja X-Api-Key: ubk_live_…. A kulcsok hasholva tárolódnak; visszavonásuk vagy elforgatása a Tartományok panelből történik.
Kérelem test
JSON, ahol a mezőnevek PascalCase formátumban vannak (From, To, …). A camelCase aliasok is elfogadottak.
| Mező | Követelmény | Leírás |
|---|---|---|
From | Igen | Küldő – a kulcs tartományán lévő személyes mailbox (fő vagy alias). A közös üzenetfogadók nem érvényesek küldőként. |
To | Igen | Fogadók – sztring, vesszővel elválasztott sztring vagy tömb |
Subject | Igen | Tárgy |
TextBody | Egyik a TextBody / HtmlBody közül | Szöveges test |
HtmlBody | Egyik a TextBody / HtmlBody közül | HTML test |
Cc | Nem | Másolat fogadók |
Bcc | Nem | Másolat fogadók (nem látható) |
ReplyTo | Nem | Válaszozz a címre |
Tag | Nem | Opcionális metaadat címke (tárolva a küldéssel együtt) |
Példa
{
"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"
}Sikeres válasz
HTTP 200 JSON-val:
{
"ErrorCode": 0,
"Message": "OK",
"MessageID": "0100018…-000000-…",
"SubmittedAt": "2026-06-23T12:00:00.000Z",
"To": "user@example.com"
}Hiba válaszok
Hibák 4xx (vagy 500 váratlan hibák esetén) JSON-val:
{
"ErrorCode": 300,
"Message": "TextBody or HtmlBody is required."
}| Hibakód | Jelentés |
|---|---|
0 | Sikeres |
10 | Hiányzó API kulcs |
11 | Érvénytelen vagy visszavonott kulcs, vagy a küldéshez nem ellenőrzött tartomány |
300 | Validációs hiba (hiányzó mezők, érvénytelen JSON stb.) |
403 | A "From" cím nem engedélyezett – a kulcs tartományának személyes levelezőt kell használni |
406 | A SES elutasította a levelet |
Példák
you@yourdomain.com helyére írja a tartományának személyes levelezőjét, és használja az API kulcsát.
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"
}'Kezdés
- Unbox fiók létrehozása és a személyes tartomány hozzáadása.
- Teljesítse az összes DNS ellenőrzési lépést a Tartományokban.
- Nyissa meg a Tartományok → a tartománya → API és generálja a tartomány kulcsát.
- Küldje el az első üzenetet a fenti példák segítségével.